diff --git a/examples/SignatureRequestCreateEmbeddedExample.cs b/examples/SignatureRequestCreateEmbeddedExample.cs index 7f9786caf..b9e866cce 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.cs +++ b/examples/SignatureRequestCreateEmbeddedExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -61,6 +65,7 @@ public static void Run() ), }, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/examples/SignatureRequestCreateEmbeddedExample.java b/examples/SignatureRequestCreateEmbeddedExample.java index 5193cee20..c3fbe6976 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.java +++ b/examples/SignatureRequestCreateEmbeddedExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -59,6 +62,7 @@ public static void main(String[] args) new File("./example_signature_request.pdf") )); signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedRequest.signers(signers); try diff --git a/examples/SignatureRequestCreateEmbeddedExample.php b/examples/SignatureRequestCreateEmbeddedExample.php index 61d74044e..95a76666d 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.php +++ b/examples/SignatureRequestCreateEmbeddedExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -46,6 +49,7 @@ ->setFiles([ ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/examples/SignatureRequestCreateEmbeddedExample.py b/examples/SignatureRequestCreateEmbeddedExample.py index 2e1b93c1d..982aed695 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.py +++ b/examples/SignatureRequestCreateEmbeddedExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -49,6 +53,7 @@ open("./example_signature_request.pdf", "rb").read(), ], signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/examples/SignatureRequestCreateEmbeddedExample.rb b/examples/SignatureRequestCreateEmbeddedExample.rb index 55db08ca7..75ff50551 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.rb +++ b/examples/SignatureRequestCreateEmbeddedExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -42,6 +45,7 @@ File.new("./example_signature_request.pdf", "r"), ] signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signer_experience = signer_experience signature_request_create_embedded_request.signers = signers begin diff --git a/examples/SignatureRequestCreateEmbeddedExample.ts b/examples/SignatureRequestCreateEmbeddedExample.ts index a2c620a2e..815b0b0e6 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.ts +++ b/examples/SignatureRequestCreateEmbeddedExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -45,6 +49,7 @@ const signatureRequestCreateEmbeddedRequest: models.SignatureRequestCreateEmbedd fs.createReadStream("./example_signature_request.pdf"), ], signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs index 40cbcbc51..16276af6b 100644 --- a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs @@ -57,6 +57,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var groupedSigners1 = new SubSignatureRequestGroupedSigners( group: "Group #1", order: 0, @@ -89,6 +93,7 @@ public static void Run() "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners ); diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java index b069e2001..c8f24f1c1 100644 --- a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java @@ -56,6 +56,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); groupedSigners1.group("Group #1"); groupedSigners1.order(0); @@ -85,6 +88,7 @@ public static void main(String[] args) "lawyer2@dropboxsign.com" )); signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedRequest.groupedSigners(groupedSigners); try diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php index f7ea5d39a..5b8196d53 100644 --- a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php @@ -44,6 +44,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) ->setGroup("Group #1") ->setOrder(0) @@ -73,6 +76,7 @@ "lawyer2@dropboxsign.com", ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setGroupedSigners($grouped_signers); try { diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py index 8bc255e6f..a65a5f7be 100644 --- a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py @@ -48,6 +48,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( group="Group #1", order=0, @@ -79,6 +83,7 @@ "lawyer2@dropboxsign.com", ], signing_options=signing_options, + signer_experience=signer_experience, grouped_signers=grouped_signers, ) diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb index 9910ee894..c936052fc 100644 --- a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb @@ -39,6 +39,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new grouped_signers_1.group = "Group #1" grouped_signers_1.order = 0 @@ -68,6 +71,7 @@ "lawyer2@dropboxsign.com", ] signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signer_experience = signer_experience signature_request_create_embedded_request.grouped_signers = grouped_signers begin diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts index a79b117ad..523db665b 100644 --- a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts @@ -44,6 +44,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const groupedSigners1: models.SubSignatureRequestGroupedSigners = { group: "Group #1", order: 0, @@ -75,6 +79,7 @@ const signatureRequestCreateEmbeddedRequest: models.SignatureRequestCreateEmbedd "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners, }; diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs index d40f34240..fc664d969 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", @@ -45,6 +49,7 @@ public static void Run() subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java index 309d422ee..62b553852 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -48,6 +51,7 @@ public static void main(String[] args) signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); try diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php index 3ff0454e8..7c5ca74d7 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") @@ -36,6 +39,7 @@ ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py index 6a5835760..351f8afa5 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", @@ -37,6 +41,7 @@ subject="Purchase Order", test_mode=True, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb index 2de72cf8a..e66a8e4c2 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" @@ -31,6 +34,7 @@ signature_request_create_embedded_with_template_request.subject = "Purchase Order" signature_request_create_embedded_with_template_request.test_mode = true signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signer_experience = signer_experience signature_request_create_embedded_with_template_request.signers = signers begin diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts index a2ee15e46..b9ab4c01e 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", @@ -33,6 +37,7 @@ const signatureRequestCreateEmbeddedWithTemplateRequest: models.SignatureRequest subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/examples/SignatureRequestEditEmbeddedExample.cs b/examples/SignatureRequestEditEmbeddedExample.cs index 356603bf6..581741a59 100644 --- a/examples/SignatureRequestEditEmbeddedExample.cs +++ b/examples/SignatureRequestEditEmbeddedExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -61,6 +65,7 @@ public static void Run() ), }, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/examples/SignatureRequestEditEmbeddedExample.java b/examples/SignatureRequestEditEmbeddedExample.java index c69cc85e4..08ee712f3 100644 --- a/examples/SignatureRequestEditEmbeddedExample.java +++ b/examples/SignatureRequestEditEmbeddedExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -59,6 +62,7 @@ public static void main(String[] args) new File("./example_signature_request.pdf") )); signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedRequest.signers(signers); try diff --git a/examples/SignatureRequestEditEmbeddedExample.php b/examples/SignatureRequestEditEmbeddedExample.php index 868c62562..99b5d3cac 100644 --- a/examples/SignatureRequestEditEmbeddedExample.php +++ b/examples/SignatureRequestEditEmbeddedExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -46,6 +49,7 @@ ->setFiles([ ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/examples/SignatureRequestEditEmbeddedExample.py b/examples/SignatureRequestEditEmbeddedExample.py index e3e5f1a87..662b716d1 100644 --- a/examples/SignatureRequestEditEmbeddedExample.py +++ b/examples/SignatureRequestEditEmbeddedExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -49,6 +53,7 @@ open("./example_signature_request.pdf", "rb").read(), ], signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/examples/SignatureRequestEditEmbeddedExample.rb b/examples/SignatureRequestEditEmbeddedExample.rb index 0e192377c..52bb7dcab 100644 --- a/examples/SignatureRequestEditEmbeddedExample.rb +++ b/examples/SignatureRequestEditEmbeddedExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -42,6 +45,7 @@ File.new("./example_signature_request.pdf", "r"), ] signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signer_experience = signer_experience signature_request_edit_embedded_request.signers = signers begin diff --git a/examples/SignatureRequestEditEmbeddedExample.ts b/examples/SignatureRequestEditEmbeddedExample.ts index f0f7580cc..393b9b1a7 100644 --- a/examples/SignatureRequestEditEmbeddedExample.ts +++ b/examples/SignatureRequestEditEmbeddedExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -45,6 +49,7 @@ const signatureRequestEditEmbeddedRequest: models.SignatureRequestEditEmbeddedRe fs.createReadStream("./example_signature_request.pdf"), ], signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs index 3be9c8142..d5a1fea39 100644 --- a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs @@ -57,6 +57,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var groupedSigners1 = new SubSignatureRequestGroupedSigners( group: "Group #1", order: 0, @@ -89,6 +93,7 @@ public static void Run() "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners ); diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java index d526e3d88..65beb30b9 100644 --- a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java @@ -56,6 +56,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); groupedSigners1.group("Group #1"); groupedSigners1.order(0); @@ -85,6 +88,7 @@ public static void main(String[] args) "lawyer2@dropboxsign.com" )); signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedRequest.groupedSigners(groupedSigners); try diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php index 08ebeac0a..f5838ae57 100644 --- a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php @@ -44,6 +44,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) ->setGroup("Group #1") ->setOrder(0) @@ -73,6 +76,7 @@ "lawyer2@dropboxsign.com", ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setGroupedSigners($grouped_signers); try { diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py index 9c26905c3..5351ba105 100644 --- a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py @@ -48,6 +48,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( group="Group #1", order=0, @@ -79,6 +83,7 @@ "lawyer2@dropboxsign.com", ], signing_options=signing_options, + signer_experience=signer_experience, grouped_signers=grouped_signers, ) diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb index 0fc7bc7a3..91096eb64 100644 --- a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb @@ -39,6 +39,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new grouped_signers_1.group = "Group #1" grouped_signers_1.order = 0 @@ -68,6 +71,7 @@ "lawyer2@dropboxsign.com", ] signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signer_experience = signer_experience signature_request_edit_embedded_request.grouped_signers = grouped_signers begin diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts index 3d828dbf8..c71986b53 100644 --- a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts @@ -44,6 +44,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const groupedSigners1: models.SubSignatureRequestGroupedSigners = { group: "Group #1", order: 0, @@ -75,6 +79,7 @@ const signatureRequestEditEmbeddedRequest: models.SignatureRequestEditEmbeddedRe "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners, }; diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs b/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs index fff755e13..67b1b52a9 100644 --- a/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", @@ -45,6 +49,7 @@ public static void Run() subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.java b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java index b0c034f3b..5c7631e73 100644 --- a/examples/SignatureRequestEditEmbeddedWithTemplateExample.java +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -48,6 +51,7 @@ public static void main(String[] args) signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); try diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.php b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php index 640f35dfc..e124eea2d 100644 --- a/examples/SignatureRequestEditEmbeddedWithTemplateExample.php +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") @@ -36,6 +39,7 @@ ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.py b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py index 92f0378ef..dad13e3ff 100644 --- a/examples/SignatureRequestEditEmbeddedWithTemplateExample.py +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", @@ -37,6 +41,7 @@ subject="Purchase Order", test_mode=True, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb index f504f1944..7d15ff59b 100644 --- a/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" @@ -31,6 +34,7 @@ signature_request_edit_embedded_with_template_request.subject = "Purchase Order" signature_request_edit_embedded_with_template_request.test_mode = true signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signer_experience = signer_experience signature_request_edit_embedded_with_template_request.signers = signers begin diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts b/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts index 0deff76bc..458727d86 100644 --- a/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", @@ -33,6 +37,7 @@ const signatureRequestEditEmbeddedWithTemplateRequest: models.SignatureRequestEd subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/examples/SignatureRequestEditExample.cs b/examples/SignatureRequestEditExample.cs index b3542b75f..f8c396304 100644 --- a/examples/SignatureRequestEditExample.cs +++ b/examples/SignatureRequestEditExample.cs @@ -29,6 +29,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -71,6 +75,7 @@ public static void Run() """), fieldOptions: fieldOptions, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/examples/SignatureRequestEditExample.java b/examples/SignatureRequestEditExample.java index ee628deef..37e037bb0 100644 --- a/examples/SignatureRequestEditExample.java +++ b/examples/SignatureRequestEditExample.java @@ -33,6 +33,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -68,6 +71,7 @@ public static void main(String[] args) """, Map.class)); signatureRequestEditRequest.fieldOptions(fieldOptions); signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signerExperience(signerExperience); signatureRequestEditRequest.signers(signers); try diff --git a/examples/SignatureRequestEditExample.php b/examples/SignatureRequestEditExample.php index 92d3747c5..e28995336 100644 --- a/examples/SignatureRequestEditExample.php +++ b/examples/SignatureRequestEditExample.php @@ -21,6 +21,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -55,6 +58,7 @@ EOD, true)) ->setFieldOptions($field_options) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/examples/SignatureRequestEditExample.py b/examples/SignatureRequestEditExample.py index 4c6fc1e74..1a1632a26 100644 --- a/examples/SignatureRequestEditExample.py +++ b/examples/SignatureRequestEditExample.py @@ -22,6 +22,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -59,6 +63,7 @@ """), field_options=field_options, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/examples/SignatureRequestEditExample.rb b/examples/SignatureRequestEditExample.rb index e55d7beee..a4bc0f315 100644 --- a/examples/SignatureRequestEditExample.rb +++ b/examples/SignatureRequestEditExample.rb @@ -16,6 +16,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -52,6 +55,7 @@ ) signature_request_edit_request.field_options = field_options signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signer_experience = signer_experience signature_request_edit_request.signers = signers begin diff --git a/examples/SignatureRequestEditExample.ts b/examples/SignatureRequestEditExample.ts index 86e3fd1b6..f68c9afd1 100644 --- a/examples/SignatureRequestEditExample.ts +++ b/examples/SignatureRequestEditExample.ts @@ -18,6 +18,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -53,6 +57,7 @@ const signatureRequestEditRequest: models.SignatureRequestEditRequest = { }, fieldOptions: fieldOptions, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/examples/TemplateCreateExample.cs b/examples/TemplateCreateExample.cs index 09fad4bd6..f34e57822 100644 --- a/examples/TemplateCreateExample.cs +++ b/examples/TemplateCreateExample.cs @@ -21,6 +21,10 @@ public static void Run() dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signerRoles1 = new SubTemplateRole( name: "Client", order: 0 @@ -106,6 +110,7 @@ public static void Run() ), }, fieldOptions: fieldOptions, + signerExperience: signerExperience, signerRoles: signerRoles, formFieldsPerDocument: formFieldsPerDocument, mergeFields: mergeFields diff --git a/examples/TemplateCreateExample.java b/examples/TemplateCreateExample.java index ebf652f91..b140cdd7f 100644 --- a/examples/TemplateCreateExample.java +++ b/examples/TemplateCreateExample.java @@ -26,6 +26,9 @@ public static void main(String[] args) var fieldOptions = new SubFieldOptions(); fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signerRoles1 = new SubTemplateRole(); signerRoles1.name("Client"); signerRoles1.order(0); @@ -98,6 +101,7 @@ public static void main(String[] args) new File("./example_signature_request.pdf") )); templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerExperience(signerExperience); templateCreateRequest.signerRoles(signerRoles); templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); templateCreateRequest.mergeFields(mergeFields); diff --git a/examples/TemplateCreateExample.php b/examples/TemplateCreateExample.php index 93b6dedd0..1723f03f3 100644 --- a/examples/TemplateCreateExample.php +++ b/examples/TemplateCreateExample.php @@ -14,6 +14,9 @@ $field_options = (new Dropbox\Sign\Model\SubFieldOptions()) ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) ->setName("Client") ->setOrder(0); @@ -85,6 +88,7 @@ ->setFiles([ ]) ->setFieldOptions($field_options) + ->setSignerExperience($signer_experience) ->setSignerRoles($signer_roles) ->setFormFieldsPerDocument($form_fields_per_document) ->setMergeFields($merge_fields); diff --git a/examples/TemplateCreateExample.py b/examples/TemplateCreateExample.py index a6ed3611e..29ea47bb7 100644 --- a/examples/TemplateCreateExample.py +++ b/examples/TemplateCreateExample.py @@ -14,6 +14,10 @@ date_format="DD - MM - YYYY", ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signer_roles_1 = models.SubTemplateRole( name="Client", order=0, @@ -92,6 +96,7 @@ open("./example_signature_request.pdf", "rb").read(), ], field_options=field_options, + signer_experience=signer_experience, signer_roles=signer_roles, form_fields_per_document=form_fields_per_document, merge_fields=merge_fields, diff --git a/examples/TemplateCreateExample.rb b/examples/TemplateCreateExample.rb index f4d623397..d7b5c992b 100644 --- a/examples/TemplateCreateExample.rb +++ b/examples/TemplateCreateExample.rb @@ -9,6 +9,9 @@ field_options = Dropbox::Sign::SubFieldOptions.new field_options.date_format = "DD - MM - YYYY" +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signer_roles_1 = Dropbox::Sign::SubTemplateRole.new signer_roles_1.name = "Client" signer_roles_1.order = 0 @@ -81,6 +84,7 @@ File.new("./example_signature_request.pdf", "r"), ] template_create_request.field_options = field_options +template_create_request.signer_experience = signer_experience template_create_request.signer_roles = signer_roles template_create_request.form_fields_per_document = form_fields_per_document template_create_request.merge_fields = merge_fields diff --git a/examples/TemplateCreateExample.ts b/examples/TemplateCreateExample.ts index 6046df4b5..2c8d38170 100644 --- a/examples/TemplateCreateExample.ts +++ b/examples/TemplateCreateExample.ts @@ -10,6 +10,10 @@ const fieldOptions: models.SubFieldOptions = { dateFormat: models.SubFieldOptions.DateFormatEnum.DdMmYyyy, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signerRoles1: models.SubTemplateRole = { name: "Client", order: 0, @@ -88,6 +92,7 @@ const templateCreateRequest: models.TemplateCreateRequest = { fs.createReadStream("./example_signature_request.pdf"), ], fieldOptions: fieldOptions, + signerExperience: signerExperience, signerRoles: signerRoles, formFieldsPerDocument: formFieldsPerDocument, mergeFields: mergeFields, diff --git a/examples/TemplateUpdateExample.cs b/examples/TemplateUpdateExample.cs index 7333c79fd..8e3afe88e 100644 --- a/examples/TemplateUpdateExample.cs +++ b/examples/TemplateUpdateExample.cs @@ -17,6 +17,10 @@ public static void Run() config.Username = "YOUR_API_KEY"; // config.AccessToken = "YOUR_ACCESS_TOKEN"; + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var formFields1 = new SubUpdateFormField( apiId: "uniqueIdHere_1", name: "New name 1" @@ -34,7 +38,6 @@ public static void Run() }; var templateUpdateRequest = new TemplateUpdateRequest( - allowFormView: false, title: "Test Title", subject: "Test Subject", message: "Test Message", @@ -42,6 +45,7 @@ public static void Run() "CC Role 1", "CC Role 2", ], + signerExperience: signerExperience, formFields: formFields ); diff --git a/examples/TemplateUpdateExample.java b/examples/TemplateUpdateExample.java index a7b731a12..5d313d966 100644 --- a/examples/TemplateUpdateExample.java +++ b/examples/TemplateUpdateExample.java @@ -23,6 +23,9 @@ public static void main(String[] args) ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var formFields1 = new SubUpdateFormField(); formFields1.apiId("uniqueIdHere_1"); formFields1.name("New name 1"); @@ -37,7 +40,6 @@ public static void main(String[] args) )); var templateUpdateRequest = new TemplateUpdateRequest(); - templateUpdateRequest.allowFormView(false); templateUpdateRequest.title("Test Title"); templateUpdateRequest.subject("Test Subject"); templateUpdateRequest.message("Test Message"); @@ -45,6 +47,7 @@ public static void main(String[] args) "CC Role 1", "CC Role 2" )); + templateUpdateRequest.signerExperience(signerExperience); templateUpdateRequest.formFields(formFields); try diff --git a/examples/TemplateUpdateExample.php b/examples/TemplateUpdateExample.php index a94ccf9cd..88aa67c51 100644 --- a/examples/TemplateUpdateExample.php +++ b/examples/TemplateUpdateExample.php @@ -11,6 +11,9 @@ $config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $form_fields_1 = (new Dropbox\Sign\Model\SubUpdateFormField()) ->setApiId("uniqueIdHere_1") ->setName("New name 1"); @@ -25,7 +28,6 @@ ]; $template_update_request = (new Dropbox\Sign\Model\TemplateUpdateRequest()) - ->setAllowFormView(false) ->setTitle("Test Title") ->setSubject("Test Subject") ->setMessage("Test Message") @@ -33,6 +35,7 @@ "CC Role 1", "CC Role 2", ]) + ->setSignerExperience($signer_experience) ->setFormFields($form_fields); try { diff --git a/examples/TemplateUpdateExample.py b/examples/TemplateUpdateExample.py index 3baeae497..46d2d7f74 100644 --- a/examples/TemplateUpdateExample.py +++ b/examples/TemplateUpdateExample.py @@ -10,6 +10,10 @@ ) with ApiClient(configuration) as api_client: + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + form_fields_1 = models.SubUpdateFormField( api_id="uniqueIdHere_1", name="New name 1", @@ -26,7 +30,6 @@ ] template_update_request = models.TemplateUpdateRequest( - allow_form_view=False, title="Test Title", subject="Test Subject", message="Test Message", @@ -34,6 +37,7 @@ "CC Role 1", "CC Role 2", ], + signer_experience=signer_experience, form_fields=form_fields, ) diff --git a/examples/TemplateUpdateExample.rb b/examples/TemplateUpdateExample.rb index 19921eb35..0642637f6 100644 --- a/examples/TemplateUpdateExample.rb +++ b/examples/TemplateUpdateExample.rb @@ -6,6 +6,9 @@ # config.access_token = "YOUR_ACCESS_TOKEN" end +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + form_fields_1 = Dropbox::Sign::SubUpdateFormField.new form_fields_1.api_id = "uniqueIdHere_1" form_fields_1.name = "New name 1" @@ -20,7 +23,6 @@ ] template_update_request = Dropbox::Sign::TemplateUpdateRequest.new -template_update_request.allow_form_view = false template_update_request.title = "Test Title" template_update_request.subject = "Test Subject" template_update_request.message = "Test Message" @@ -28,6 +30,7 @@ "CC Role 1", "CC Role 2", ] +template_update_request.signer_experience = signer_experience template_update_request.form_fields = form_fields begin diff --git a/examples/TemplateUpdateExample.ts b/examples/TemplateUpdateExample.ts index 4740cc51e..ce1e9c658 100644 --- a/examples/TemplateUpdateExample.ts +++ b/examples/TemplateUpdateExample.ts @@ -6,6 +6,10 @@ const apiCaller = new api.TemplateApi(); apiCaller.username = "YOUR_API_KEY"; // apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const formFields1: models.SubUpdateFormField = { apiId: "uniqueIdHere_1", name: "New name 1", @@ -22,7 +26,6 @@ const formFields = [ ]; const templateUpdateRequest: models.TemplateUpdateRequest = { - allowFormView: false, title: "Test Title", subject: "Test Subject", message: "Test Message", @@ -30,6 +33,7 @@ const templateUpdateRequest: models.TemplateUpdateRequest = { "CC Role 1", "CC Role 2", ], + signerExperience: signerExperience, formFields: formFields, }; diff --git a/examples/json/SignatureRequestCreateEmbeddedRequest.json b/examples/json/SignatureRequestCreateEmbeddedRequest.json index ba7accb05..33dc6faeb 100644 --- a/examples/json/SignatureRequestCreateEmbeddedRequest.json +++ b/examples/json/SignatureRequestCreateEmbeddedRequest.json @@ -29,5 +29,8 @@ "phone": false, "default_type": "draw" }, - "test_mode": true + "test_mode": true, + "signer_experience": { + "form_view": "disabled" + } } diff --git a/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json b/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json index fb8cb1935..9ef1082de 100644 --- a/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json +++ b/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json @@ -47,5 +47,8 @@ "phone": false, "default_type": "draw" }, + "signer_experience": { + "form_view": "disabled" + }, "test_mode": true } diff --git a/examples/json/SignatureRequestCreateEmbeddedResponse.json b/examples/json/SignatureRequestCreateEmbeddedResponse.json index 5def13bab..989e76c10 100644 --- a/examples/json/SignatureRequestCreateEmbeddedResponse.json +++ b/examples/json/SignatureRequestCreateEmbeddedResponse.json @@ -47,6 +47,9 @@ "cc_email_addresses": [ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com" - ] + ], + "signer_experience": { + "form_view": "disabled" + } } } diff --git a/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json b/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json index 742998123..7d5cc961e 100644 --- a/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json +++ b/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json @@ -19,5 +19,8 @@ "phone": false, "default_type": "draw" }, - "test_mode": true + "test_mode": true, + "signer_experience": { + "form_view": "disabled" + } } diff --git a/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json b/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json index 3099142f2..535b2cc6f 100644 --- a/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json +++ b/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json @@ -40,6 +40,9 @@ ], "cc_email_addresses": [ "accounting@dropboxsign.com" - ] + ], + "signer_experience": { + "form_view": "disabled" + } } } diff --git a/examples/json/SignatureRequestEditEmbeddedRequest.json b/examples/json/SignatureRequestEditEmbeddedRequest.json index ba7accb05..33dc6faeb 100644 --- a/examples/json/SignatureRequestEditEmbeddedRequest.json +++ b/examples/json/SignatureRequestEditEmbeddedRequest.json @@ -29,5 +29,8 @@ "phone": false, "default_type": "draw" }, - "test_mode": true + "test_mode": true, + "signer_experience": { + "form_view": "disabled" + } } diff --git a/examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json b/examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json index fb8cb1935..12381d070 100644 --- a/examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json +++ b/examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json @@ -47,5 +47,8 @@ "phone": false, "default_type": "draw" }, - "test_mode": true + "test_mode": true, + "signer_experience": { + "form_view": "disabled" + } } diff --git a/examples/json/SignatureRequestEditEmbeddedResponse.json b/examples/json/SignatureRequestEditEmbeddedResponse.json index 5def13bab..989e76c10 100644 --- a/examples/json/SignatureRequestEditEmbeddedResponse.json +++ b/examples/json/SignatureRequestEditEmbeddedResponse.json @@ -47,6 +47,9 @@ "cc_email_addresses": [ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com" - ] + ], + "signer_experience": { + "form_view": "disabled" + } } } diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json index 742998123..7d5cc961e 100644 --- a/examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json +++ b/examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json @@ -19,5 +19,8 @@ "phone": false, "default_type": "draw" }, - "test_mode": true + "test_mode": true, + "signer_experience": { + "form_view": "disabled" + } } diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json index 3099142f2..535b2cc6f 100644 --- a/examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json +++ b/examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json @@ -40,6 +40,9 @@ ], "cc_email_addresses": [ "accounting@dropboxsign.com" - ] + ], + "signer_experience": { + "form_view": "disabled" + } } } diff --git a/examples/json/SignatureRequestEditRequest.json b/examples/json/SignatureRequestEditRequest.json index 3d1b98727..6fb4105f5 100644 --- a/examples/json/SignatureRequestEditRequest.json +++ b/examples/json/SignatureRequestEditRequest.json @@ -35,5 +35,8 @@ "field_options": { "date_format": "DD - MM - YYYY" }, - "test_mode": true + "test_mode": true, + "signer_experience": { + "form_view": "disabled" + } } diff --git a/examples/json/SignatureRequestGetResponse.json b/examples/json/SignatureRequestGetResponse.json index 1e4ec3d38..c5a152279 100644 --- a/examples/json/SignatureRequestGetResponse.json +++ b/examples/json/SignatureRequestGetResponse.json @@ -53,6 +53,9 @@ "has_sms_auth": false } ], - "cc_email_addresses": [] + "cc_email_addresses": [], + "signer_experience": { + "form_view": "disabled" + } } } diff --git a/examples/json/TemplateCreateRequest.json b/examples/json/TemplateCreateRequest.json index b18275f8a..b212d44bc 100644 --- a/examples/json/TemplateCreateRequest.json +++ b/examples/json/TemplateCreateRequest.json @@ -62,5 +62,8 @@ "page": 1 } ], - "test_mode": true + "test_mode": true, + "signer_experience": { + "form_view": "disabled" + } } diff --git a/examples/json/TemplateUpdateRequest.json b/examples/json/TemplateUpdateRequest.json index dbef5e530..c88e0ee6f 100644 --- a/examples/json/TemplateUpdateRequest.json +++ b/examples/json/TemplateUpdateRequest.json @@ -1,5 +1,7 @@ { - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "title": "Test Title", "subject": "Test Subject", "message": "Test Message", diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 4f4f1d57e..a66a55e6b 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -7941,10 +7941,6 @@ components: description: '_t__EmbeddedEditUrl::ALLOW_EDIT_CCS' type: boolean default: false - allow_form_view: - description: '_t__EmbeddedEditUrl::ALLOW_FORM_VIEW' - type: boolean - default: false cc_roles: description: '_t__EmbeddedEditUrl::CC_ROLES' type: array @@ -7981,6 +7977,8 @@ components: description: '_t__EmbeddedEditUrl::TEST_MODE' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object FaxLineAddUserRequest: required: @@ -8383,10 +8381,6 @@ components: description: '_t__SignatureRequestCreateEmbedded::ALLOW_DECLINE' type: boolean default: false - allow_form_view: - description: '_t__SignatureRequestCreateEmbedded::ALLOW_FORM_VIEW' - type: boolean - default: false allow_reassign: description: '_t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN' type: boolean @@ -8462,6 +8456,8 @@ components: description: '_t__SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' expires_at: description: '_t__SignatureRequestCreateEmbedded::EXPIRES_AT' type: integer @@ -8538,6 +8534,8 @@ components: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditRequest: properties: @@ -8566,10 +8564,6 @@ components: description: '_t__SignatureRequestSend::ALLOW_DECLINE' type: boolean default: false - allow_form_view: - description: '_t__SignatureRequestSend::ALLOW_FORM_VIEW' - type: boolean - default: false allow_reassign: description: '_t__SignatureRequestSend::ALLOW_REASSIGN' type: boolean @@ -8652,6 +8646,8 @@ components: description: '_t__SignatureRequestSend::EXPIRES_AT' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditEmbeddedRequest: required: @@ -8682,10 +8678,6 @@ components: description: '_t__SignatureRequestCreateEmbedded::ALLOW_DECLINE' type: boolean default: false - allow_form_view: - description: '_t__SignatureRequestCreateEmbedded::ALLOW_FORM_VIEW' - type: boolean - default: false allow_reassign: description: '_t__SignatureRequestCreateEmbedded::ALLOW_REASSIGN' type: boolean @@ -8765,6 +8757,8 @@ components: description: '_t__SignatureRequestCreateEmbedded::EXPIRES_AT' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditEmbeddedWithTemplateRequest: required: @@ -8837,6 +8831,8 @@ components: description: '_t__SignatureRequestCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditWithTemplateRequest: description: '' @@ -8912,6 +8908,8 @@ components: description: '_t__SignatureRequestSendWithTemplate::TITLE' type: string maxLength: 255 + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestRemindRequest: required: @@ -8956,10 +8954,6 @@ components: description: '_t__SignatureRequestSend::ALLOW_REASSIGN' type: boolean default: false - allow_form_view: - description: '_t__SignatureRequestSend::ALLOW_FORM_VIEW' - type: boolean - default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -9044,6 +9038,8 @@ components: description: '_t__SignatureRequestSend::EXPIRES_AT' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestSendWithTemplateRequest: description: '' @@ -9125,6 +9121,8 @@ components: description: '_t__SignatureRequestSendWithTemplate::TITLE' type: string maxLength: 255 + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestUpdateRequest: required: @@ -9940,6 +9938,18 @@ components: type: string format: email type: object + SubSignerExperience: + description: '_t__Sub::SignerExperience::DESCRIPTION' + properties: + form_view: + description: '_t__Sub::SignerExperience::DEFAULT' + type: string + enum: + - disabled + - enabled + - enabled_by_default + - forced + type: object SubTemplateRole: properties: name: @@ -10122,10 +10132,6 @@ components: description: '_t__TemplateCreate::ALLOW_REASSIGN' type: boolean default: false - allow_form_view: - description: '_t__TemplateCreate::ALLOW_FORM_VIEW' - type: boolean - default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -10190,6 +10196,8 @@ components: description: '_t__TemplateCreate::USE_PREEXISTING_FIELDS' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateCreateEmbeddedDraftRequest: required: @@ -10214,10 +10222,6 @@ components: description: '_t__TemplateCreateEmbeddedDraft::ALLOW_REASSIGN' type: boolean default: false - allow_form_view: - description: '_t__TemplateCreateEmbeddedDraft::ALLOW_FORM_VIEW' - type: boolean - default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -10304,6 +10308,8 @@ components: description: '_t__TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateRemoveUserRequest: properties: @@ -10322,9 +10328,6 @@ components: type: array items: type: string - allow_form_view: - description: '_t__TemplateUpdate::ALLOW_FORM_VIEW' - type: boolean title: description: '_t__TemplateUpdate::TITLE' type: string @@ -10341,6 +10344,8 @@ components: type: array items: $ref: '#/components/schemas/SubUpdateFormField' + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateUpdateFilesRequest: properties: @@ -10391,10 +10396,6 @@ components: description: '_t__UnclaimedDraftCreate::ALLOW_DECLINE' type: boolean default: false - allow_form_view: - description: '_t__UnclaimedDraftCreate::ALLOW_FORM_VIEW' - type: boolean - default: false attachments: description: '_t__SubAttachment::LIST_DESCRIPTION' type: array @@ -10484,6 +10485,8 @@ components: description: '_t__UnclaimedDraftCreate::EXPIRES_AT' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object UnclaimedDraftCreateEmbeddedRequest: description: '' @@ -10510,10 +10513,6 @@ components: description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_DECLINE' type: boolean default: false - allow_form_view: - description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_FORM_VIEW' - type: boolean - default: false allow_reassign: description: '_t__UnclaimedDraftCreateEmbedded::ALLOW_REASSIGN' type: boolean @@ -11623,6 +11622,8 @@ components: description: '_t__SignatureRequestResponse::BULK_SEND_JOB_ID' type: string nullable: true + signer_experience: + $ref: '#/components/schemas/SignatureRequestSignerExperience' type: object x-internal-class: true SignatureRequestResponseAttachment: @@ -11980,6 +11981,21 @@ components: nullable: true type: object x-internal-class: true + SignatureRequestSignerExperience: + description: '_t__SignatureRequestSignerExperience::DESCRIPTION' + required: + - form_view + properties: + form_view: + description: '_t__Sub::SignerExperience::DEFAULT' + type: string + enum: + - disabled + - enabled + - enabled_by_default + - forced + type: object + x-internal-class: true TeamResponse: description: '_t__TeamResponse::DESCRIPTION' properties: @@ -12148,10 +12164,8 @@ components: type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' - allow_form_view: - description: '_t__TemplateResponse::ALLOW_FORM_VIEW' - type: boolean - nullable: false + signer_experience: + $ref: '#/components/schemas/SignatureRequestSignerExperience' type: object x-internal-class: true TemplateResponseAccount: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index dfd272f52..4caa81441 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -8041,10 +8041,6 @@ components: description: 'This allows the requester to enable/disable to add or change CC roles when editing the template.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false cc_roles: description: 'The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.' type: array @@ -8087,6 +8083,8 @@ components: description: 'Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object FaxLineAddUserRequest: required: @@ -8567,10 +8565,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8677,6 +8671,8 @@ components: **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' expires_at: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer @@ -8765,6 +8761,8 @@ components: **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditRequest: properties: @@ -8805,10 +8803,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8923,6 +8917,8 @@ components: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditEmbeddedRequest: required: @@ -8965,10 +8961,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -9079,6 +9071,8 @@ components: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditEmbeddedWithTemplateRequest: required: @@ -9163,6 +9157,8 @@ components: **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditWithTemplateRequest: description: '' @@ -9251,6 +9247,8 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestRemindRequest: required: @@ -9310,10 +9308,6 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -9432,6 +9426,8 @@ components: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestSendWithTemplateRequest: description: '' @@ -9531,6 +9527,8 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestUpdateRequest: required: @@ -10486,6 +10484,23 @@ components: type: string format: email type: object + SubSignerExperience: + description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.' + properties: + form_view: + description: |- + Changes the form view setting experienced by the signer. Supported versions are: + - `disabled` - Form view is disabled, and the signer cannot change it + - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle + - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle + - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + type: string + enum: + - disabled + - enabled + - enabled_by_default + - forced + type: object SubTemplateRole: properties: name: @@ -10708,10 +10723,6 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -10795,6 +10806,8 @@ components: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateCreateEmbeddedDraftRequest: required: @@ -10828,10 +10841,6 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -10941,6 +10950,8 @@ components: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateRemoveUserRequest: properties: @@ -10959,9 +10970,6 @@ components: type: array items: type: string - allow_form_view: - description: 'The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names.' - type: boolean title: description: 'The title you want to assign to the SignatureRequest.' type: string @@ -10978,6 +10986,8 @@ components: type: array items: $ref: '#/components/schemas/SubUpdateFormField' + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateUpdateFilesRequest: properties: @@ -11040,10 +11050,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -11158,6 +11164,8 @@ components: **NOTE:** This does not correspond to the **expires_at** returned in the response. type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object UnclaimedDraftCreateEmbeddedRequest: description: '' @@ -11190,10 +11198,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -12367,6 +12371,8 @@ components: description: 'The ID of the Bulk Send job which sent the signature request, if applicable.' type: string nullable: true + signer_experience: + $ref: '#/components/schemas/SignatureRequestSignerExperience' type: object x-internal-class: true SignatureRequestResponseAttachment: @@ -12728,6 +12734,26 @@ components: nullable: true type: object x-internal-class: true + SignatureRequestSignerExperience: + description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.' + required: + - form_view + properties: + form_view: + description: |- + Changes the form view setting experienced by the signer. Supported versions are: + - `disabled` - Form view is disabled, and the signer cannot change it + - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle + - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle + - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + type: string + enum: + - disabled + - enabled + - enabled_by_default + - forced + type: object + x-internal-class: true TeamResponse: description: 'Contains information about your team and its members' properties: @@ -12899,10 +12925,8 @@ components: type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - nullable: false + signer_experience: + $ref: '#/components/schemas/SignatureRequestSignerExperience' type: object x-internal-class: true TemplateResponseAccount: diff --git a/openapi.yaml b/openapi.yaml index c3f5354b8..ce88fbaf4 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -7926,10 +7926,6 @@ components: description: 'This allows the requester to enable/disable to add or change CC roles when editing the template.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false cc_roles: description: 'The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.' type: array @@ -7972,6 +7968,8 @@ components: description: 'Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object FaxLineAddUserRequest: required: @@ -8452,10 +8450,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8562,6 +8556,8 @@ components: **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' expires_at: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer @@ -8650,6 +8646,8 @@ components: **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditRequest: properties: @@ -8690,10 +8688,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8808,6 +8802,8 @@ components: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditEmbeddedRequest: required: @@ -8850,10 +8846,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -8964,6 +8956,8 @@ components: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditEmbeddedWithTemplateRequest: required: @@ -9048,6 +9042,8 @@ components: **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestEditWithTemplateRequest: description: '' @@ -9136,6 +9132,8 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestRemindRequest: required: @@ -9195,10 +9193,6 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -9306,6 +9300,8 @@ components: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestSendWithTemplateRequest: description: '' @@ -9394,6 +9390,8 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object SignatureRequestUpdateRequest: required: @@ -10349,6 +10347,23 @@ components: type: string format: email type: object + SubSignerExperience: + description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.' + properties: + form_view: + description: |- + Changes the form view setting experienced by the signer. Supported versions are: + - `disabled` - Form view is disabled, and the signer cannot change it + - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle + - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle + - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + type: string + enum: + - disabled + - enabled + - enabled_by_default + - forced + type: object SubTemplateRole: properties: name: @@ -10571,10 +10586,6 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -10658,6 +10669,8 @@ components: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateCreateEmbeddedDraftRequest: required: @@ -10691,10 +10704,6 @@ components: **NOTE:** Only available for Premium plan and higher. type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -10804,6 +10813,8 @@ components: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateRemoveUserRequest: properties: @@ -10822,9 +10833,6 @@ components: type: array items: type: string - allow_form_view: - description: 'The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names.' - type: boolean title: description: 'The title you want to assign to the SignatureRequest.' type: string @@ -10841,6 +10849,8 @@ components: type: array items: $ref: '#/components/schemas/SubUpdateFormField' + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object TemplateUpdateFilesRequest: properties: @@ -10903,10 +10913,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false attachments: description: 'A list describing the attachments' type: array @@ -11021,6 +11027,8 @@ components: **NOTE:** This does not correspond to the **expires_at** returned in the response. type: integer nullable: true + signer_experience: + $ref: '#/components/schemas/SubSignerExperience' type: object UnclaimedDraftCreateEmbeddedRequest: description: '' @@ -11053,10 +11061,6 @@ components: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. @@ -12230,6 +12234,8 @@ components: description: 'The ID of the Bulk Send job which sent the signature request, if applicable.' type: string nullable: true + signer_experience: + $ref: '#/components/schemas/SignatureRequestSignerExperience' type: object x-internal-class: true SignatureRequestResponseAttachment: @@ -12591,6 +12597,26 @@ components: nullable: true type: object x-internal-class: true + SignatureRequestSignerExperience: + description: 'Configuration options for modifying the settings of the signer application. Supports changing the form view behavior.' + required: + - form_view + properties: + form_view: + description: |- + Changes the form view setting experienced by the signer. Supported versions are: + - `disabled` - Form view is disabled, and the signer cannot change it + - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle + - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle + - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + type: string + enum: + - disabled + - enabled + - enabled_by_default + - forced + type: object + x-internal-class: true TeamResponse: description: 'Contains information about your team and its members' properties: @@ -12762,10 +12788,8 @@ components: type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' - allow_form_view: - description: 'Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.' - type: boolean - nullable: false + signer_experience: + $ref: '#/components/schemas/SignatureRequestSignerExperience' type: object x-internal-class: true TemplateResponseAccount: diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs index 7f9786caf..b9e866cce 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -61,6 +65,7 @@ public static void Run() ), }, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs index 40cbcbc51..16276af6b 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs @@ -57,6 +57,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var groupedSigners1 = new SubSignatureRequestGroupedSigners( group: "Group #1", order: 0, @@ -89,6 +93,7 @@ public static void Run() "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners ); diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs index d40f34240..fc664d969 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", @@ -45,6 +49,7 @@ public static void Run() subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs index 356603bf6..581741a59 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -61,6 +65,7 @@ public static void Run() ), }, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs index 3be9c8142..d5a1fea39 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs @@ -57,6 +57,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var groupedSigners1 = new SubSignatureRequestGroupedSigners( group: "Group #1", order: 0, @@ -89,6 +93,7 @@ public static void Run() "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners ); diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs index fff755e13..67b1b52a9 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs @@ -25,6 +25,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", @@ -45,6 +49,7 @@ public static void Run() subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs index b3542b75f..f8c396304 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs @@ -29,6 +29,10 @@ public static void Run() upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -71,6 +75,7 @@ public static void Run() """), fieldOptions: fieldOptions, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs index 09fad4bd6..f34e57822 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs @@ -21,6 +21,10 @@ public static void Run() dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signerRoles1 = new SubTemplateRole( name: "Client", order: 0 @@ -106,6 +110,7 @@ public static void Run() ), }, fieldOptions: fieldOptions, + signerExperience: signerExperience, signerRoles: signerRoles, formFieldsPerDocument: formFieldsPerDocument, mergeFields: mergeFields diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateExample.cs index 7333c79fd..8e3afe88e 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateExample.cs @@ -17,6 +17,10 @@ public static void Run() config.Username = "YOUR_API_KEY"; // config.AccessToken = "YOUR_ACCESS_TOKEN"; + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var formFields1 = new SubUpdateFormField( apiId: "uniqueIdHere_1", name: "New name 1" @@ -34,7 +38,6 @@ public static void Run() }; var templateUpdateRequest = new TemplateUpdateRequest( - allowFormView: false, title: "Test Title", subject: "Test Subject", message: "Test Message", @@ -42,6 +45,7 @@ public static void Run() "CC Role 1", "CC Role 2", ], + signerExperience: signerExperience, formFields: formFields ); diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java index 5193cee20..c3fbe6976 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -59,6 +62,7 @@ public static void main(String[] args) new File("./example_signature_request.pdf") )); signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedRequest.signers(signers); try diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java index b069e2001..c8f24f1c1 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java @@ -56,6 +56,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); groupedSigners1.group("Group #1"); groupedSigners1.order(0); @@ -85,6 +88,7 @@ public static void main(String[] args) "lawyer2@dropboxsign.com" )); signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedRequest.groupedSigners(groupedSigners); try diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java index 309d422ee..62b553852 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -48,6 +51,7 @@ public static void main(String[] args) signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); try diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java index c69cc85e4..08ee712f3 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -59,6 +62,7 @@ public static void main(String[] args) new File("./example_signature_request.pdf") )); signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedRequest.signers(signers); try diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java index d526e3d88..65beb30b9 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java @@ -56,6 +56,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); groupedSigners1.group("Group #1"); groupedSigners1.order(0); @@ -85,6 +88,7 @@ public static void main(String[] args) "lawyer2@dropboxsign.com" )); signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedRequest.groupedSigners(groupedSigners); try diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java index b0c034f3b..5c7631e73 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java @@ -30,6 +30,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -48,6 +51,7 @@ public static void main(String[] args) signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); try diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java index ee628deef..37e037bb0 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java @@ -33,6 +33,9 @@ public static void main(String[] args) signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -68,6 +71,7 @@ public static void main(String[] args) """, Map.class)); signatureRequestEditRequest.fieldOptions(fieldOptions); signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signerExperience(signerExperience); signatureRequestEditRequest.signers(signers); try diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java index ebf652f91..b140cdd7f 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java @@ -26,6 +26,9 @@ public static void main(String[] args) var fieldOptions = new SubFieldOptions(); fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signerRoles1 = new SubTemplateRole(); signerRoles1.name("Client"); signerRoles1.order(0); @@ -98,6 +101,7 @@ public static void main(String[] args) new File("./example_signature_request.pdf") )); templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerExperience(signerExperience); templateCreateRequest.signerRoles(signerRoles); templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); templateCreateRequest.mergeFields(mergeFields); diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateExample.java index a7b731a12..5d313d966 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateExample.java @@ -23,6 +23,9 @@ public static void main(String[] args) ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var formFields1 = new SubUpdateFormField(); formFields1.apiId("uniqueIdHere_1"); formFields1.name("New name 1"); @@ -37,7 +40,6 @@ public static void main(String[] args) )); var templateUpdateRequest = new TemplateUpdateRequest(); - templateUpdateRequest.allowFormView(false); templateUpdateRequest.title("Test Title"); templateUpdateRequest.subject("Test Subject"); templateUpdateRequest.message("Test Message"); @@ -45,6 +47,7 @@ public static void main(String[] args) "CC Role 1", "CC Role 2" )); + templateUpdateRequest.signerExperience(signerExperience); templateUpdateRequest.formFields(formFields); try diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts index a2c620a2e..815b0b0e6 100644 --- a/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -45,6 +49,7 @@ const signatureRequestCreateEmbeddedRequest: models.SignatureRequestCreateEmbedd fs.createReadStream("./example_signature_request.pdf"), ], signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts index a79b117ad..523db665b 100644 --- a/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts @@ -44,6 +44,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const groupedSigners1: models.SubSignatureRequestGroupedSigners = { group: "Group #1", order: 0, @@ -75,6 +79,7 @@ const signatureRequestCreateEmbeddedRequest: models.SignatureRequestCreateEmbedd "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners, }; diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts index a2ee15e46..b9ab4c01e 100644 --- a/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", @@ -33,6 +37,7 @@ const signatureRequestCreateEmbeddedWithTemplateRequest: models.SignatureRequest subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts index f0f7580cc..393b9b1a7 100644 --- a/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts +++ b/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -45,6 +49,7 @@ const signatureRequestEditEmbeddedRequest: models.SignatureRequestEditEmbeddedRe fs.createReadStream("./example_signature_request.pdf"), ], signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts index 3d828dbf8..c71986b53 100644 --- a/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts +++ b/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts @@ -44,6 +44,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const groupedSigners1: models.SubSignatureRequestGroupedSigners = { group: "Group #1", order: 0, @@ -75,6 +79,7 @@ const signatureRequestEditEmbeddedRequest: models.SignatureRequestEditEmbeddedRe "lawyer2@dropboxsign.com", ], signingOptions: signingOptions, + signerExperience: signerExperience, groupedSigners: groupedSigners, }; diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts index 0deff76bc..458727d86 100644 --- a/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts +++ b/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts @@ -14,6 +14,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", @@ -33,6 +37,7 @@ const signatureRequestEditEmbeddedWithTemplateRequest: models.SignatureRequestEd subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/sandbox/node/src/SignatureRequestEditExample.ts b/sandbox/node/src/SignatureRequestEditExample.ts index 86e3fd1b6..f68c9afd1 100644 --- a/sandbox/node/src/SignatureRequestEditExample.ts +++ b/sandbox/node/src/SignatureRequestEditExample.ts @@ -18,6 +18,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -53,6 +57,7 @@ const signatureRequestEditRequest: models.SignatureRequestEditRequest = { }, fieldOptions: fieldOptions, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/sandbox/node/src/TemplateCreateExample.ts b/sandbox/node/src/TemplateCreateExample.ts index 6046df4b5..2c8d38170 100644 --- a/sandbox/node/src/TemplateCreateExample.ts +++ b/sandbox/node/src/TemplateCreateExample.ts @@ -10,6 +10,10 @@ const fieldOptions: models.SubFieldOptions = { dateFormat: models.SubFieldOptions.DateFormatEnum.DdMmYyyy, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signerRoles1: models.SubTemplateRole = { name: "Client", order: 0, @@ -88,6 +92,7 @@ const templateCreateRequest: models.TemplateCreateRequest = { fs.createReadStream("./example_signature_request.pdf"), ], fieldOptions: fieldOptions, + signerExperience: signerExperience, signerRoles: signerRoles, formFieldsPerDocument: formFieldsPerDocument, mergeFields: mergeFields, diff --git a/sandbox/node/src/TemplateUpdateExample.ts b/sandbox/node/src/TemplateUpdateExample.ts index 4740cc51e..ce1e9c658 100644 --- a/sandbox/node/src/TemplateUpdateExample.ts +++ b/sandbox/node/src/TemplateUpdateExample.ts @@ -6,6 +6,10 @@ const apiCaller = new api.TemplateApi(); apiCaller.username = "YOUR_API_KEY"; // apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const formFields1: models.SubUpdateFormField = { apiId: "uniqueIdHere_1", name: "New name 1", @@ -22,7 +26,6 @@ const formFields = [ ]; const templateUpdateRequest: models.TemplateUpdateRequest = { - allowFormView: false, title: "Test Title", subject: "Test Subject", message: "Test Message", @@ -30,6 +33,7 @@ const templateUpdateRequest: models.TemplateUpdateRequest = { "CC Role 1", "CC Role 2", ], + signerExperience: signerExperience, formFields: formFields, }; diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php index 61d74044e..95a76666d 100644 --- a/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -46,6 +49,7 @@ ->setFiles([ ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php index f7ea5d39a..5b8196d53 100644 --- a/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php @@ -44,6 +44,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) ->setGroup("Group #1") ->setOrder(0) @@ -73,6 +76,7 @@ "lawyer2@dropboxsign.com", ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setGroupedSigners($grouped_signers); try { diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php index 3ff0454e8..7c5ca74d7 100644 --- a/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") @@ -36,6 +39,7 @@ ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedExample.php index 868c62562..99b5d3cac 100644 --- a/sandbox/php/src/SignatureRequestEditEmbeddedExample.php +++ b/sandbox/php/src/SignatureRequestEditEmbeddedExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -46,6 +49,7 @@ ->setFiles([ ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php index 08ebeac0a..f5838ae57 100644 --- a/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php +++ b/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php @@ -44,6 +44,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) ->setGroup("Group #1") ->setOrder(0) @@ -73,6 +76,7 @@ "lawyer2@dropboxsign.com", ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setGroupedSigners($grouped_signers); try { diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php index 640f35dfc..e124eea2d 100644 --- a/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php +++ b/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php @@ -18,6 +18,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") @@ -36,6 +39,7 @@ ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/sandbox/php/src/SignatureRequestEditExample.php b/sandbox/php/src/SignatureRequestEditExample.php index 92d3747c5..e28995336 100644 --- a/sandbox/php/src/SignatureRequestEditExample.php +++ b/sandbox/php/src/SignatureRequestEditExample.php @@ -21,6 +21,9 @@ ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -55,6 +58,7 @@ EOD, true)) ->setFieldOptions($field_options) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/sandbox/php/src/TemplateCreateExample.php b/sandbox/php/src/TemplateCreateExample.php index 93b6dedd0..1723f03f3 100644 --- a/sandbox/php/src/TemplateCreateExample.php +++ b/sandbox/php/src/TemplateCreateExample.php @@ -14,6 +14,9 @@ $field_options = (new Dropbox\Sign\Model\SubFieldOptions()) ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) ->setName("Client") ->setOrder(0); @@ -85,6 +88,7 @@ ->setFiles([ ]) ->setFieldOptions($field_options) + ->setSignerExperience($signer_experience) ->setSignerRoles($signer_roles) ->setFormFieldsPerDocument($form_fields_per_document) ->setMergeFields($merge_fields); diff --git a/sandbox/php/src/TemplateUpdateExample.php b/sandbox/php/src/TemplateUpdateExample.php index a94ccf9cd..88aa67c51 100644 --- a/sandbox/php/src/TemplateUpdateExample.php +++ b/sandbox/php/src/TemplateUpdateExample.php @@ -11,6 +11,9 @@ $config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $form_fields_1 = (new Dropbox\Sign\Model\SubUpdateFormField()) ->setApiId("uniqueIdHere_1") ->setName("New name 1"); @@ -25,7 +28,6 @@ ]; $template_update_request = (new Dropbox\Sign\Model\TemplateUpdateRequest()) - ->setAllowFormView(false) ->setTitle("Test Title") ->setSubject("Test Subject") ->setMessage("Test Message") @@ -33,6 +35,7 @@ "CC Role 1", "CC Role 2", ]) + ->setSignerExperience($signer_experience) ->setFormFields($form_fields); try { diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py index 2e1b93c1d..982aed695 100644 --- a/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -49,6 +53,7 @@ open("./example_signature_request.pdf", "rb").read(), ], signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py index 8bc255e6f..a65a5f7be 100644 --- a/sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py @@ -48,6 +48,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( group="Group #1", order=0, @@ -79,6 +83,7 @@ "lawyer2@dropboxsign.com", ], signing_options=signing_options, + signer_experience=signer_experience, grouped_signers=grouped_signers, ) diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py index 6a5835760..351f8afa5 100644 --- a/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", @@ -37,6 +41,7 @@ subject="Purchase Order", test_mode=True, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/sandbox/python/src/SignatureRequestEditEmbeddedExample.py b/sandbox/python/src/SignatureRequestEditEmbeddedExample.py index e3e5f1a87..662b716d1 100644 --- a/sandbox/python/src/SignatureRequestEditEmbeddedExample.py +++ b/sandbox/python/src/SignatureRequestEditEmbeddedExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -49,6 +53,7 @@ open("./example_signature_request.pdf", "rb").read(), ], signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py b/sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py index 9c26905c3..5351ba105 100644 --- a/sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py +++ b/sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py @@ -48,6 +48,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( group="Group #1", order=0, @@ -79,6 +83,7 @@ "lawyer2@dropboxsign.com", ], signing_options=signing_options, + signer_experience=signer_experience, grouped_signers=grouped_signers, ) diff --git a/sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py b/sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py index 92f0378ef..dad13e3ff 100644 --- a/sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py +++ b/sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py @@ -18,6 +18,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", @@ -37,6 +41,7 @@ subject="Purchase Order", test_mode=True, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/sandbox/python/src/SignatureRequestEditExample.py b/sandbox/python/src/SignatureRequestEditExample.py index 4c6fc1e74..1a1632a26 100644 --- a/sandbox/python/src/SignatureRequestEditExample.py +++ b/sandbox/python/src/SignatureRequestEditExample.py @@ -22,6 +22,10 @@ upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -59,6 +63,7 @@ """), field_options=field_options, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) diff --git a/sandbox/python/src/TemplateCreateExample.py b/sandbox/python/src/TemplateCreateExample.py index a6ed3611e..29ea47bb7 100644 --- a/sandbox/python/src/TemplateCreateExample.py +++ b/sandbox/python/src/TemplateCreateExample.py @@ -14,6 +14,10 @@ date_format="DD - MM - YYYY", ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signer_roles_1 = models.SubTemplateRole( name="Client", order=0, @@ -92,6 +96,7 @@ open("./example_signature_request.pdf", "rb").read(), ], field_options=field_options, + signer_experience=signer_experience, signer_roles=signer_roles, form_fields_per_document=form_fields_per_document, merge_fields=merge_fields, diff --git a/sandbox/python/src/TemplateUpdateExample.py b/sandbox/python/src/TemplateUpdateExample.py index 3baeae497..46d2d7f74 100644 --- a/sandbox/python/src/TemplateUpdateExample.py +++ b/sandbox/python/src/TemplateUpdateExample.py @@ -10,6 +10,10 @@ ) with ApiClient(configuration) as api_client: + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + form_fields_1 = models.SubUpdateFormField( api_id="uniqueIdHere_1", name="New name 1", @@ -26,7 +30,6 @@ ] template_update_request = models.TemplateUpdateRequest( - allow_form_view=False, title="Test Title", subject="Test Subject", message="Test Message", @@ -34,6 +37,7 @@ "CC Role 1", "CC Role 2", ], + signer_experience=signer_experience, form_fields=form_fields, ) diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb index 55db08ca7..75ff50551 100644 --- a/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -42,6 +45,7 @@ File.new("./example_signature_request.pdf", "r"), ] signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signer_experience = signer_experience signature_request_create_embedded_request.signers = signers begin diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb index 9910ee894..c936052fc 100644 --- a/sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb @@ -39,6 +39,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new grouped_signers_1.group = "Group #1" grouped_signers_1.order = 0 @@ -68,6 +71,7 @@ "lawyer2@dropboxsign.com", ] signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signer_experience = signer_experience signature_request_create_embedded_request.grouped_signers = grouped_signers begin diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb index 2de72cf8a..e66a8e4c2 100644 --- a/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" @@ -31,6 +34,7 @@ signature_request_create_embedded_with_template_request.subject = "Purchase Order" signature_request_create_embedded_with_template_request.test_mode = true signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signer_experience = signer_experience signature_request_create_embedded_with_template_request.signers = signers begin diff --git a/sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb b/sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb index 0e192377c..52bb7dcab 100644 --- a/sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb +++ b/sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -42,6 +45,7 @@ File.new("./example_signature_request.pdf", "r"), ] signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signer_experience = signer_experience signature_request_edit_embedded_request.signers = signers begin diff --git a/sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb b/sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb index 0fc7bc7a3..91096eb64 100644 --- a/sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb +++ b/sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb @@ -39,6 +39,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new grouped_signers_1.group = "Group #1" grouped_signers_1.order = 0 @@ -68,6 +71,7 @@ "lawyer2@dropboxsign.com", ] signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signer_experience = signer_experience signature_request_edit_embedded_request.grouped_signers = grouped_signers begin diff --git a/sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb index f504f1944..7d15ff59b 100644 --- a/sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb +++ b/sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb @@ -13,6 +13,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" @@ -31,6 +34,7 @@ signature_request_edit_embedded_with_template_request.subject = "Purchase Order" signature_request_edit_embedded_with_template_request.test_mode = true signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signer_experience = signer_experience signature_request_edit_embedded_with_template_request.signers = signers begin diff --git a/sandbox/ruby/src/SignatureRequestEditExample.rb b/sandbox/ruby/src/SignatureRequestEditExample.rb index e55d7beee..a4bc0f315 100644 --- a/sandbox/ruby/src/SignatureRequestEditExample.rb +++ b/sandbox/ruby/src/SignatureRequestEditExample.rb @@ -16,6 +16,9 @@ signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -52,6 +55,7 @@ ) signature_request_edit_request.field_options = field_options signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signer_experience = signer_experience signature_request_edit_request.signers = signers begin diff --git a/sandbox/ruby/src/TemplateCreateExample.rb b/sandbox/ruby/src/TemplateCreateExample.rb index f4d623397..d7b5c992b 100644 --- a/sandbox/ruby/src/TemplateCreateExample.rb +++ b/sandbox/ruby/src/TemplateCreateExample.rb @@ -9,6 +9,9 @@ field_options = Dropbox::Sign::SubFieldOptions.new field_options.date_format = "DD - MM - YYYY" +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signer_roles_1 = Dropbox::Sign::SubTemplateRole.new signer_roles_1.name = "Client" signer_roles_1.order = 0 @@ -81,6 +84,7 @@ File.new("./example_signature_request.pdf", "r"), ] template_create_request.field_options = field_options +template_create_request.signer_experience = signer_experience template_create_request.signer_roles = signer_roles template_create_request.form_fields_per_document = form_fields_per_document template_create_request.merge_fields = merge_fields diff --git a/sandbox/ruby/src/TemplateUpdateExample.rb b/sandbox/ruby/src/TemplateUpdateExample.rb index 19921eb35..0642637f6 100644 --- a/sandbox/ruby/src/TemplateUpdateExample.rb +++ b/sandbox/ruby/src/TemplateUpdateExample.rb @@ -6,6 +6,9 @@ # config.access_token = "YOUR_ACCESS_TOKEN" end +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + form_fields_1 = Dropbox::Sign::SubUpdateFormField.new form_fields_1.api_id = "uniqueIdHere_1" form_fields_1.name = "New name 1" @@ -20,7 +23,6 @@ ] template_update_request = Dropbox::Sign::TemplateUpdateRequest.new -template_update_request.allow_form_view = false template_update_request.title = "Test Title" template_update_request.subject = "Test Subject" template_update_request.message = "Test Message" @@ -28,6 +30,7 @@ "CC Role 1", "CC Role 2", ] +template_update_request.signer_experience = signer_experience template_update_request.form_fields = form_fields begin diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index c287fe1c8..a5b79ae48 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -301,6 +301,7 @@ Class | Method | HTTP request | Description - [Model.SignatureRequestResponseSignatures](docs/SignatureRequestResponseSignatures.md) - [Model.SignatureRequestSendRequest](docs/SignatureRequestSendRequest.md) - [Model.SignatureRequestSendWithTemplateRequest](docs/SignatureRequestSendWithTemplateRequest.md) + - [Model.SignatureRequestSignerExperience](docs/SignatureRequestSignerExperience.md) - [Model.SignatureRequestUpdateRequest](docs/SignatureRequestUpdateRequest.md) - [Model.SubAttachment](docs/SubAttachment.md) - [Model.SubBulkSignerList](docs/SubBulkSignerList.md) @@ -332,6 +333,7 @@ Class | Method | HTTP request | Description - [Model.SubSignatureRequestGroupedSigners](docs/SubSignatureRequestGroupedSigners.md) - [Model.SubSignatureRequestSigner](docs/SubSignatureRequestSigner.md) - [Model.SubSignatureRequestTemplateSigner](docs/SubSignatureRequestTemplateSigner.md) + - [Model.SubSignerExperience](docs/SubSignerExperience.md) - [Model.SubSigningOptions](docs/SubSigningOptions.md) - [Model.SubTeamResponse](docs/SubTeamResponse.md) - [Model.SubTemplateRole](docs/SubTemplateRole.md) diff --git a/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md index 5ba89617f..4480dcba8 100644 --- a/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/dotnet/docs/BulkSendJobGetResponseSignatureRequests.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request's documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List<string>** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List<string>** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional] +**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request's documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List<string>** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List<string>** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The id of the BulkSendJob. | [optional] **SignerExperience** | [**SignatureRequestSignerExperience**](SignatureRequestSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/EmbeddedEditUrlRequest.md b/sdks/dotnet/docs/EmbeddedEditUrlRequest.md index b62194404..94801e1a6 100644 --- a/sdks/dotnet/docs/EmbeddedEditUrlRequest.md +++ b/sdks/dotnet/docs/EmbeddedEditUrlRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AllowEditCcs** | **bool** | This allows the requester to enable/disable to add or change CC roles when editing the template. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.

Remove all merge fields on the template by passing an empty array `[]`. | [optional] **PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

**NOTE:** This parameter overwrites `show_preview=true` (if set). | [optional] [default to false]**ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**TestMode** | **bool** | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [optional] [default to false] +**AllowEditCcs** | **bool** | This allows the requester to enable/disable to add or change CC roles when editing the template. | [optional] [default to false]**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.

Remove all merge fields on the template by passing an empty array `[]`. | [optional] **PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).

**NOTE:** This parameter overwrites `show_preview=true` (if set). | [optional] [default to false]**ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**TestMode** | **bool** | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [optional] [default to false]**SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestApi.md b/sdks/dotnet/docs/SignatureRequestApi.md index fe084fa62..025b2005b 100644 --- a/sdks/dotnet/docs/SignatureRequestApi.md +++ b/sdks/dotnet/docs/SignatureRequestApi.md @@ -507,6 +507,10 @@ public class SignatureRequestCreateEmbeddedExample upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -543,6 +547,7 @@ public class SignatureRequestCreateEmbeddedExample ), }, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); @@ -650,6 +655,10 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", @@ -670,6 +679,7 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); @@ -781,6 +791,10 @@ public class SignatureRequestEditExample upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -823,6 +837,7 @@ public class SignatureRequestEditExample """), fieldOptions: fieldOptions, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); @@ -932,6 +947,10 @@ public class SignatureRequestEditEmbeddedExample upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestSigner( name: "Jack", emailAddress: "jack@example.com", @@ -968,6 +987,7 @@ public class SignatureRequestEditEmbeddedExample ), }, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); @@ -1077,6 +1097,10 @@ public class SignatureRequestEditEmbeddedWithTemplateExample upload: true ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", name: "George", @@ -1097,6 +1121,7 @@ public class SignatureRequestEditEmbeddedWithTemplateExample subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers ); diff --git a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md index 72691fc6d..e80c727c4 100644 --- a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] **ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 61bab9b3a..29272902f 100644 --- a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md index d43f04d2e..bd5d898af 100644 --- a/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 8be8d1b17..18da50568 100644 --- a/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditRequest.md b/sdks/dotnet/docs/SignatureRequestEditRequest.md index 6817506b5..11380d70e 100644 --- a/sdks/dotnet/docs/SignatureRequestEditRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md index d9ac882ee..34327f625 100644 --- a/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestResponse.md b/sdks/dotnet/docs/SignatureRequestResponse.md index e2b6d0a31..8ed53023d 100644 --- a/sdks/dotnet/docs/SignatureRequestResponse.md +++ b/sdks/dotnet/docs/SignatureRequestResponse.md @@ -5,7 +5,7 @@ Contains information about a signature request. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request's documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List<string>** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List<string>** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The ID of the Bulk Send job which sent the signature request, if applicable. | [optional] +**TestMode** | **bool** | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | [optional] [default to false]**SignatureRequestId** | **string** | The id of the SignatureRequest. | [optional] **RequesterEmailAddress** | **string** | The email address of the initiator of the SignatureRequest. | [optional] **Title** | **string** | The title the specified Account uses for the SignatureRequest. | [optional] **OriginalTitle** | **string** | Default Label for account. | [optional] **Subject** | **string** | The subject in the email that was initially sent to the signers. | [optional] **Message** | **string** | The custom message in the email that was initially sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the signature request. | [optional] **CreatedAt** | **int** | Time the signature request was created. | [optional] **ExpiresAt** | **int?** | The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **IsComplete** | **bool** | Whether or not the SignatureRequest has been fully executed by all signers. | [optional] **IsDeclined** | **bool** | Whether or not the SignatureRequest has been declined by a signer. | [optional] **HasError** | **bool** | Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings). | [optional] **FilesUrl** | **string** | The URL where a copy of the request's documents can be downloaded. | [optional] **SigningUrl** | **string** | The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing. | [optional] **DetailsUrl** | **string** | The URL where the requester and the signers can view the current status of the SignatureRequest. | [optional] **CcEmailAddresses** | **List<string>** | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | [optional] **SigningRedirectUrl** | **string** | The URL you want the signer redirected to after they successfully sign. | [optional] **FinalCopyUri** | **string** | The path where the completed document can be downloaded | [optional] **TemplateIds** | **List<string>** | Templates IDs used in this SignatureRequest (if any). | [optional] **CustomFields** | [**List<SignatureRequestResponseCustomFieldBase>**](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses `SignatureRequestResponseCustomFieldText`
* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **ResponseData** | [**List<SignatureRequestResponseDataBase>**](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | [optional] **Signatures** | [**List<SignatureRequestResponseSignatures>**](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | [optional] **BulkSendJobId** | **string** | The ID of the Bulk Send job which sent the signature request, if applicable. | [optional] **SignerExperience** | [**SignatureRequestSignerExperience**](SignatureRequestSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestSendRequest.md b/sdks/dotnet/docs/SignatureRequestSendRequest.md index cc8636f7d..0ca5f8fc4 100644 --- a/sdks/dotnet/docs/SignatureRequestSendRequest.md +++ b/sdks/dotnet/docs/SignatureRequestSendRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] +**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] **SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md index 12fc09be5..a98f3e6f2 100644 --- a/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/dotnet/docs/SignatureRequestSendWithTemplateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] +**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | **Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional] **ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br>
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestSignerExperience.md b/sdks/dotnet/docs/SignatureRequestSignerExperience.md new file mode 100644 index 000000000..9c0e6d76d --- /dev/null +++ b/sdks/dotnet/docs/SignatureRequestSignerExperience.md @@ -0,0 +1,11 @@ +# Dropbox.Sign.Model.SignatureRequestSignerExperience +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FormView** | **string** | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/sdks/dotnet/docs/SubSignerExperience.md b/sdks/dotnet/docs/SubSignerExperience.md new file mode 100644 index 000000000..e9b7af925 --- /dev/null +++ b/sdks/dotnet/docs/SubSignerExperience.md @@ -0,0 +1,11 @@ +# Dropbox.Sign.Model.SubSignerExperience +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FormView** | **string** | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/sdks/dotnet/docs/TemplateApi.md b/sdks/dotnet/docs/TemplateApi.md index c11d86fff..36247c5ba 100644 --- a/sdks/dotnet/docs/TemplateApi.md +++ b/sdks/dotnet/docs/TemplateApi.md @@ -152,6 +152,10 @@ public class TemplateCreateExample dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY ); + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var signerRoles1 = new SubTemplateRole( name: "Client", order: 0 @@ -237,6 +241,7 @@ public class TemplateCreateExample ), }, fieldOptions: fieldOptions, + signerExperience: signerExperience, signerRoles: signerRoles, formFieldsPerDocument: formFieldsPerDocument, mergeFields: mergeFields @@ -1173,6 +1178,10 @@ public class TemplateUpdateExample config.Username = "YOUR_API_KEY"; // config.AccessToken = "YOUR_ACCESS_TOKEN"; + var signerExperience = new SubSignerExperience( + formView: SubSignerExperience.FormViewEnum.Disabled + ); + var formFields1 = new SubUpdateFormField( apiId: "uniqueIdHere_1", name: "New name 1" @@ -1190,7 +1199,6 @@ public class TemplateUpdateExample }; var templateUpdateRequest = new TemplateUpdateRequest( - allowFormView: false, title: "Test Title", subject: "Test Subject", message: "Test Message", @@ -1198,6 +1206,7 @@ public class TemplateUpdateExample "CC Role 1", "CC Role 2", ], + signerExperience: signerExperience, formFields: formFields ); diff --git a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md index ddc4f561f..34cf9ddd9 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [optional] [default to true]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false] +**ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [optional] [default to true]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerRoles** | **bool** | Provide users the ability to review/edit the template signer roles. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] [default to false]**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false]**SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateCreateRequest.md b/sdks/dotnet/docs/TemplateCreateRequest.md index e1d8d3a95..1129b47bc 100644 --- a/sdks/dotnet/docs/TemplateCreateRequest.md +++ b/sdks/dotnet/docs/TemplateCreateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | **SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false] +**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | **SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional] **ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional] **Message** | **string** | The default template email message. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false]**SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponse.md b/sdks/dotnet/docs/TemplateResponse.md index f3797e38f..e0897746a 100644 --- a/sdks/dotnet/docs/TemplateResponse.md +++ b/sdks/dotnet/docs/TemplateResponse.md @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] +**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Dictionary<string, Object>** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | [optional] **SignerExperience** | [**SignatureRequestSignerExperience**](SignatureRequestSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateUpdateRequest.md b/sdks/dotnet/docs/TemplateUpdateRequest.md index 374eb6720..4951f1e0e 100644 --- a/sdks/dotnet/docs/TemplateUpdateRequest.md +++ b/sdks/dotnet/docs/TemplateUpdateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request. | [optional] **AllowFormView** | **bool** | The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. | [optional] **Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **Subject** | **string** | The new default template email subject. | [optional] **Message** | **string** | The new default template email message. | [optional] **FormFields** | [**List<SubUpdateFormField>**](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | [optional] +**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request. | [optional] **Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **Subject** | **string** | The new default template email subject. | [optional] **Message** | **string** | The new default template email message. | [optional] **FormFields** | [**List<SubUpdateFormField>**](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | [optional] **SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md index 253a166ea..d3bc89c77 100644 --- a/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | **RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to true]**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerPage** | **bool** | Provide users the ability to review/edit the signers. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**HoldRequest** | **bool** | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [optional] [default to false]**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Type** | **string** | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [optional] [default to TypeEnum.RequestSignature]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] +**ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | **RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to true]**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **ForceSignerPage** | **bool** | Provide users the ability to review/edit the signers. | [optional] [default to false]**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the subject and message. | [optional] [default to false]**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**HoldRequest** | **bool** | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [optional] [default to false]**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature. | [optional] **ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.

- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **SkipMeNow** | **bool** | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [optional] [default to false]**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Type** | **string** | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [optional] [default to TypeEnum.RequestSignature]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md b/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md index 544c77356..e270e0a70 100644 --- a/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/dotnet/docs/UnclaimedDraftCreateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**AllowFormView** | **bool** | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] +**Type** | **string** | The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional] **CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional] **ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | [optional] **CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional] **FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional] **FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | [optional] **FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional] **FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)

**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.

* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional] **HideTextTags** | **bool** | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [optional] [default to false]**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional] **Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]**Signers** | [**List<SubUnclaimedDraftSigner>**](SubUnclaimedDraftSigner.md) | Add Signers to your Unclaimed Draft Signature Request. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**UsePreexistingFields** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**UseTextTags** | **bool** | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] **SignerExperience** | [**SubSignerExperience**](SubSignerExperience.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs index 5d8db6306..49affd92a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/BulkSendJobGetResponseSignatureRequests.cs @@ -66,7 +66,8 @@ protected BulkSendJobGetResponseSignatureRequests() { } /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.. /// An array of signature objects, 1 for each signer.. /// The id of the BulkSendJob.. - public BulkSendJobGetResponseSignatureRequests(bool testMode = false, string signatureRequestId = default(string), string requesterEmailAddress = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Dictionary metadata = default(Dictionary), int createdAt = default(int), int? expiresAt = default(int?), bool isComplete = default(bool), bool isDeclined = default(bool), bool hasError = default(bool), string filesUrl = default(string), string signingUrl = default(string), string detailsUrl = default(string), List ccEmailAddresses = default(List), string signingRedirectUrl = default(string), string finalCopyUri = default(string), List templateIds = default(List), List customFields = default(List), List attachments = default(List), List responseData = default(List), List signatures = default(List), string bulkSendJobId = default(string)) + /// signerExperience. + public BulkSendJobGetResponseSignatureRequests(bool testMode = false, string signatureRequestId = default(string), string requesterEmailAddress = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Dictionary metadata = default(Dictionary), int createdAt = default(int), int? expiresAt = default(int?), bool isComplete = default(bool), bool isDeclined = default(bool), bool hasError = default(bool), string filesUrl = default(string), string signingUrl = default(string), string detailsUrl = default(string), List ccEmailAddresses = default(List), string signingRedirectUrl = default(string), string finalCopyUri = default(string), List templateIds = default(List), List customFields = default(List), List attachments = default(List), List responseData = default(List), List signatures = default(List), string bulkSendJobId = default(string), SignatureRequestSignerExperience signerExperience = default(SignatureRequestSignerExperience)) { this.TestMode = testMode; @@ -94,6 +95,7 @@ protected BulkSendJobGetResponseSignatureRequests() { } this.ResponseData = responseData; this.Signatures = signatures; this.BulkSendJobId = bulkSendJobId; + this.SignerExperience = signerExperience; } /// @@ -287,6 +289,12 @@ public static BulkSendJobGetResponseSignatureRequests Init(string jsonData) [DataMember(Name = "bulk_send_job_id", EmitDefaultValue = true)] public string BulkSendJobId { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SignatureRequestSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -320,6 +328,7 @@ public override string ToString() sb.Append(" ResponseData: ").Append(ResponseData).Append("\n"); sb.Append(" Signatures: ").Append(Signatures).Append("\n"); sb.Append(" BulkSendJobId: ").Append(BulkSendJobId).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -481,6 +490,11 @@ public bool Equals(BulkSendJobGetResponseSignatureRequests input) this.BulkSendJobId == input.BulkSendJobId || (this.BulkSendJobId != null && this.BulkSendJobId.Equals(input.BulkSendJobId)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -578,6 +592,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.BulkSendJobId.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -769,6 +787,13 @@ public List GetOpenApiTypes() Type = "string", Value = BulkSendJobId, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SignatureRequestSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs index db605e7ea..96a7b5316 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/EmbeddedEditUrlRequest.cs @@ -42,7 +42,6 @@ protected EmbeddedEditUrlRequest() { } /// Initializes a new instance of the class. /// /// This allows the requester to enable/disable to add or change CC roles when editing the template. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.. /// editorOptions. /// Provide users the ability to review/edit the template signer roles. (default to false). @@ -52,11 +51,11 @@ protected EmbeddedEditUrlRequest() { } /// This allows the requester to enable the editor/preview experience. (default to false). /// When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. (default to true). /// Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. (default to false). - public EmbeddedEditUrlRequest(bool allowEditCcs = false, bool allowFormView = false, List ccRoles = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List mergeFields = default(List), bool previewOnly = false, bool showPreview = false, bool showProgressStepper = true, bool testMode = false) + /// signerExperience. + public EmbeddedEditUrlRequest(bool allowEditCcs = false, List ccRoles = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List mergeFields = default(List), bool previewOnly = false, bool showPreview = false, bool showProgressStepper = true, bool testMode = false, SubSignerExperience signerExperience = default(SubSignerExperience)) { this.AllowEditCcs = allowEditCcs; - this.AllowFormView = allowFormView; this.CcRoles = ccRoles; this.EditorOptions = editorOptions; this.ForceSignerRoles = forceSignerRoles; @@ -66,6 +65,7 @@ protected EmbeddedEditUrlRequest() { } this.ShowPreview = showPreview; this.ShowProgressStepper = showProgressStepper; this.TestMode = testMode; + this.SignerExperience = signerExperience; } /// @@ -91,13 +91,6 @@ public static EmbeddedEditUrlRequest Init(string jsonData) [DataMember(Name = "allow_edit_ccs", EmitDefaultValue = true)] public bool AllowEditCcs { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. /// @@ -160,6 +153,12 @@ public static EmbeddedEditUrlRequest Init(string jsonData) [DataMember(Name = "test_mode", EmitDefaultValue = true)] public bool TestMode { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -169,7 +168,6 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class EmbeddedEditUrlRequest {\n"); sb.Append(" AllowEditCcs: ").Append(AllowEditCcs).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" EditorOptions: ").Append(EditorOptions).Append("\n"); sb.Append(" ForceSignerRoles: ").Append(ForceSignerRoles).Append("\n"); @@ -179,6 +177,7 @@ public override string ToString() sb.Append(" ShowPreview: ").Append(ShowPreview).Append("\n"); sb.Append(" ShowProgressStepper: ").Append(ShowProgressStepper).Append("\n"); sb.Append(" TestMode: ").Append(TestMode).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -218,10 +217,6 @@ public bool Equals(EmbeddedEditUrlRequest input) this.AllowEditCcs == input.AllowEditCcs || this.AllowEditCcs.Equals(input.AllowEditCcs) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.CcRoles == input.CcRoles || this.CcRoles != null && @@ -262,6 +257,11 @@ public bool Equals(EmbeddedEditUrlRequest input) ( this.TestMode == input.TestMode || this.TestMode.Equals(input.TestMode) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -275,7 +275,6 @@ public override int GetHashCode() { int hashCode = 41; hashCode = (hashCode * 59) + this.AllowEditCcs.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.CcRoles != null) { hashCode = (hashCode * 59) + this.CcRoles.GetHashCode(); @@ -294,6 +293,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.ShowPreview.GetHashCode(); hashCode = (hashCode * 59) + this.ShowProgressStepper.GetHashCode(); hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -318,13 +321,6 @@ public List GetOpenApiTypes() Value = AllowEditCcs, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "cc_roles", Property = "CcRoles", @@ -387,6 +383,13 @@ public List GetOpenApiTypes() Type = "bool", Value = TestMode, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs index 873106832..8248c671e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs @@ -46,7 +46,6 @@ protected SignatureRequestCreateEmbeddedRequest() { } /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. (default to false). /// A list describing the attachments. /// The email addresses that should be CCed.. @@ -65,8 +64,9 @@ protected SignatureRequestCreateEmbeddedRequest() { } /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). + /// signerExperience. /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public SignatureRequestCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, SubSignerExperience signerExperience = default(SubSignerExperience), int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -80,7 +80,6 @@ protected SignatureRequestCreateEmbeddedRequest() { } this.Signers = signers; this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; - this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -98,6 +97,7 @@ protected SignatureRequestCreateEmbeddedRequest() { } this.Title = title; this.UseTextTags = useTextTags; this.PopulateAutoFillFields = populateAutoFillFields; + this.SignerExperience = signerExperience; this.ExpiresAt = expiresAt; } @@ -159,13 +159,6 @@ public static SignatureRequestCreateEmbeddedRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. /// @@ -283,6 +276,12 @@ public static SignatureRequestCreateEmbeddedRequest Init(string jsonData) [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] public bool PopulateAutoFillFields { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. /// @@ -304,7 +303,6 @@ public override string ToString() sb.Append(" Signers: ").Append(Signers).Append("\n"); sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -322,6 +320,7 @@ public override string ToString() sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -391,10 +390,6 @@ public bool Equals(SignatureRequestCreateEmbeddedRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -482,6 +477,11 @@ public bool Equals(SignatureRequestCreateEmbeddedRequest input) this.PopulateAutoFillFields == input.PopulateAutoFillFields || this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) + ) && ( this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && @@ -519,7 +519,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -573,6 +572,10 @@ public override int GetHashCode() } hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } if (this.ExpiresAt != null) { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); @@ -654,13 +657,6 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", @@ -780,6 +776,13 @@ public List GetOpenApiTypes() Value = PopulateAutoFillFields, }); types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); + types.Add(new OpenApiType() { Name = "expires_at", Property = "ExpiresAt", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs index b0296ffdb..6d00faf43 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.cs @@ -56,7 +56,8 @@ protected SignatureRequestCreateEmbeddedWithTemplateRequest() { } /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). - public SignatureRequestCreateEmbeddedWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool populateAutoFillFields = false) + /// signerExperience. + public SignatureRequestCreateEmbeddedWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool populateAutoFillFields = false, SubSignerExperience signerExperience = default(SubSignerExperience)) { // to ensure "templateIds" is required (not null) @@ -89,6 +90,7 @@ protected SignatureRequestCreateEmbeddedWithTemplateRequest() { } this.TestMode = testMode; this.Title = title; this.PopulateAutoFillFields = populateAutoFillFields; + this.SignerExperience = signerExperience; } /// @@ -211,6 +213,12 @@ public static SignatureRequestCreateEmbeddedWithTemplateRequest Init(string json [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] public bool PopulateAutoFillFields { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -234,6 +242,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -347,6 +356,11 @@ public bool Equals(SignatureRequestCreateEmbeddedWithTemplateRequest input) ( this.PopulateAutoFillFields == input.PopulateAutoFillFields || this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -410,6 +424,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -549,6 +567,13 @@ public List GetOpenApiTypes() Type = "bool", Value = PopulateAutoFillFields, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs index 67f19385b..958a237ff 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs @@ -46,7 +46,6 @@ protected SignatureRequestEditEmbeddedRequest() { } /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. (default to false). /// A list describing the attachments. /// The email addresses that should be CCed.. @@ -66,7 +65,8 @@ protected SignatureRequestEditEmbeddedRequest() { } /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + /// signerExperience. + public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?), SubSignerExperience signerExperience = default(SubSignerExperience)) { // to ensure "clientId" is required (not null) @@ -80,7 +80,6 @@ protected SignatureRequestEditEmbeddedRequest() { } this.Signers = signers; this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; - this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -99,6 +98,7 @@ protected SignatureRequestEditEmbeddedRequest() { } this.UseTextTags = useTextTags; this.PopulateAutoFillFields = populateAutoFillFields; this.ExpiresAt = expiresAt; + this.SignerExperience = signerExperience; } /// @@ -159,13 +159,6 @@ public static SignatureRequestEditEmbeddedRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. /// @@ -290,6 +283,12 @@ public static SignatureRequestEditEmbeddedRequest Init(string jsonData) [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -304,7 +303,6 @@ public override string ToString() sb.Append(" Signers: ").Append(Signers).Append("\n"); sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -323,6 +321,7 @@ public override string ToString() sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -391,10 +390,6 @@ public bool Equals(SignatureRequestEditEmbeddedRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -486,6 +481,11 @@ public bool Equals(SignatureRequestEditEmbeddedRequest input) this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && this.ExpiresAt.Equals(input.ExpiresAt)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -519,7 +519,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -577,6 +576,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -654,13 +657,6 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", @@ -786,6 +782,13 @@ public List GetOpenApiTypes() Type = "int?", Value = ExpiresAt, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs index fcf32fa66..d1a36b057 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedWithTemplateRequest.cs @@ -56,7 +56,8 @@ protected SignatureRequestEditEmbeddedWithTemplateRequest() { } /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). - public SignatureRequestEditEmbeddedWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool populateAutoFillFields = false) + /// signerExperience. + public SignatureRequestEditEmbeddedWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool populateAutoFillFields = false, SubSignerExperience signerExperience = default(SubSignerExperience)) { // to ensure "templateIds" is required (not null) @@ -89,6 +90,7 @@ protected SignatureRequestEditEmbeddedWithTemplateRequest() { } this.TestMode = testMode; this.Title = title; this.PopulateAutoFillFields = populateAutoFillFields; + this.SignerExperience = signerExperience; } /// @@ -211,6 +213,12 @@ public static SignatureRequestEditEmbeddedWithTemplateRequest Init(string jsonDa [DataMember(Name = "populate_auto_fill_fields", EmitDefaultValue = true)] public bool PopulateAutoFillFields { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -234,6 +242,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -347,6 +356,11 @@ public bool Equals(SignatureRequestEditEmbeddedWithTemplateRequest input) ( this.PopulateAutoFillFields == input.PopulateAutoFillFields || this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -410,6 +424,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -549,6 +567,13 @@ public List GetOpenApiTypes() Type = "bool", Value = PopulateAutoFillFields, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs index 04e30e565..c3f8e39b9 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs @@ -46,7 +46,6 @@ protected SignatureRequestEditRequest() { } /// Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). /// A list describing the attachments. /// The email addresses that should be CCed.. @@ -67,7 +66,8 @@ protected SignatureRequestEditRequest() { } /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) + /// signerExperience. + public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?), SubSignerExperience signerExperience = default(SubSignerExperience)) { this.Files = files; @@ -75,7 +75,6 @@ protected SignatureRequestEditRequest() { } this.Signers = signers; this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; - this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -96,6 +95,7 @@ protected SignatureRequestEditRequest() { } this.Title = title; this.UseTextTags = useTextTags; this.ExpiresAt = expiresAt; + this.SignerExperience = signerExperience; } /// @@ -149,13 +149,6 @@ public static SignatureRequestEditRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. /// @@ -294,6 +287,12 @@ public static SignatureRequestEditRequest Init(string jsonData) [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -307,7 +306,6 @@ public override string ToString() sb.Append(" Signers: ").Append(Signers).Append("\n"); sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -328,6 +326,7 @@ public override string ToString() sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -391,10 +390,6 @@ public bool Equals(SignatureRequestEditRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -496,6 +491,11 @@ public bool Equals(SignatureRequestEditRequest input) this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && this.ExpiresAt.Equals(input.ExpiresAt)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -525,7 +525,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.GroupedSigners.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -591,6 +590,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -661,13 +664,6 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", @@ -807,6 +803,13 @@ public List GetOpenApiTypes() Type = "int?", Value = ExpiresAt, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs index 84990b8ff..fbd70545c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditWithTemplateRequest.cs @@ -57,7 +57,8 @@ protected SignatureRequestEditWithTemplateRequest() { } /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. - public SignatureRequestEditWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string)) + /// signerExperience. + public SignatureRequestEditWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), SubSignerExperience signerExperience = default(SubSignerExperience)) { // to ensure "templateIds" is required (not null) @@ -86,6 +87,7 @@ protected SignatureRequestEditWithTemplateRequest() { } this.Subject = subject; this.TestMode = testMode; this.Title = title; + this.SignerExperience = signerExperience; } /// @@ -215,6 +217,12 @@ public static SignatureRequestEditWithTemplateRequest Init(string jsonData) [DataMember(Name = "title", EmitDefaultValue = true)] public string Title { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -239,6 +247,7 @@ public override string ToString() sb.Append(" Subject: ").Append(Subject).Append("\n"); sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -357,6 +366,11 @@ public bool Equals(SignatureRequestEditWithTemplateRequest input) this.Title == input.Title || (this.Title != null && this.Title.Equals(input.Title)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -424,6 +438,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Title.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -570,6 +588,13 @@ public List GetOpenApiTypes() Type = "string", Value = Title, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs index 514181b2f..9550c6f5a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestResponse.cs @@ -66,7 +66,8 @@ protected SignatureRequestResponse() { } /// An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.. /// An array of signature objects, 1 for each signer.. /// The ID of the Bulk Send job which sent the signature request, if applicable.. - public SignatureRequestResponse(bool testMode = false, string signatureRequestId = default(string), string requesterEmailAddress = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Dictionary metadata = default(Dictionary), int createdAt = default(int), int? expiresAt = default(int?), bool isComplete = default(bool), bool isDeclined = default(bool), bool hasError = default(bool), string filesUrl = default(string), string signingUrl = default(string), string detailsUrl = default(string), List ccEmailAddresses = default(List), string signingRedirectUrl = default(string), string finalCopyUri = default(string), List templateIds = default(List), List customFields = default(List), List attachments = default(List), List responseData = default(List), List signatures = default(List), string bulkSendJobId = default(string)) + /// signerExperience. + public SignatureRequestResponse(bool testMode = false, string signatureRequestId = default(string), string requesterEmailAddress = default(string), string title = default(string), string originalTitle = default(string), string subject = default(string), string message = default(string), Dictionary metadata = default(Dictionary), int createdAt = default(int), int? expiresAt = default(int?), bool isComplete = default(bool), bool isDeclined = default(bool), bool hasError = default(bool), string filesUrl = default(string), string signingUrl = default(string), string detailsUrl = default(string), List ccEmailAddresses = default(List), string signingRedirectUrl = default(string), string finalCopyUri = default(string), List templateIds = default(List), List customFields = default(List), List attachments = default(List), List responseData = default(List), List signatures = default(List), string bulkSendJobId = default(string), SignatureRequestSignerExperience signerExperience = default(SignatureRequestSignerExperience)) { this.TestMode = testMode; @@ -94,6 +95,7 @@ protected SignatureRequestResponse() { } this.ResponseData = responseData; this.Signatures = signatures; this.BulkSendJobId = bulkSendJobId; + this.SignerExperience = signerExperience; } /// @@ -287,6 +289,12 @@ public static SignatureRequestResponse Init(string jsonData) [DataMember(Name = "bulk_send_job_id", EmitDefaultValue = true)] public string BulkSendJobId { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SignatureRequestSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -320,6 +328,7 @@ public override string ToString() sb.Append(" ResponseData: ").Append(ResponseData).Append("\n"); sb.Append(" Signatures: ").Append(Signatures).Append("\n"); sb.Append(" BulkSendJobId: ").Append(BulkSendJobId).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -481,6 +490,11 @@ public bool Equals(SignatureRequestResponse input) this.BulkSendJobId == input.BulkSendJobId || (this.BulkSendJobId != null && this.BulkSendJobId.Equals(input.BulkSendJobId)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -578,6 +592,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.BulkSendJobId.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -769,6 +787,13 @@ public List GetOpenApiTypes() Type = "string", Value = BulkSendJobId, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SignatureRequestSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs index 73345fca1..c5f307cb5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs @@ -47,7 +47,6 @@ protected SignatureRequestSendRequest() { } /// Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// The email addresses that should be CCed.. /// The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.. @@ -68,7 +67,8 @@ protected SignatureRequestSendRequest() { } /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, bool allowFormView = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) + /// signerExperience. + public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?), SubSignerExperience signerExperience = default(SubSignerExperience)) { this.Files = files; @@ -77,7 +77,6 @@ protected SignatureRequestSendRequest() { } this.GroupedSigners = groupedSigners; this.AllowDecline = allowDecline; this.AllowReassign = allowReassign; - this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; this.ClientId = clientId; @@ -98,6 +97,7 @@ protected SignatureRequestSendRequest() { } this.Title = title; this.UseTextTags = useTextTags; this.ExpiresAt = expiresAt; + this.SignerExperience = signerExperience; } /// @@ -158,13 +158,6 @@ public static SignatureRequestSendRequest Init(string jsonData) [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] public bool AllowReassign { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// A list describing the attachments /// @@ -304,6 +297,12 @@ public static SignatureRequestSendRequest Init(string jsonData) [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -318,7 +317,6 @@ public override string ToString() sb.Append(" GroupedSigners: ").Append(GroupedSigners).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); @@ -339,6 +337,7 @@ public override string ToString() sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -406,10 +405,6 @@ public bool Equals(SignatureRequestSendRequest input) this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -511,6 +506,11 @@ public bool Equals(SignatureRequestSendRequest input) this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && this.ExpiresAt.Equals(input.ExpiresAt)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -541,7 +541,6 @@ public override int GetHashCode() } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -607,6 +606,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -684,13 +687,6 @@ public List GetOpenApiTypes() Value = AllowReassign, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", @@ -830,6 +826,13 @@ public List GetOpenApiTypes() Type = "int?", Value = ExpiresAt, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs index 071627daa..2ddf4ecbe 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendWithTemplateRequest.cs @@ -58,7 +58,8 @@ protected SignatureRequestSendWithTemplateRequest() { } /// The subject in the email that will be sent to the signers.. /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. - public SignatureRequestSendWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string)) + /// signerExperience. + public SignatureRequestSendWithTemplateRequest(List templateIds = default(List), bool allowDecline = false, List ccs = default(List), string clientId = default(string), List customFields = default(List), List files = default(List), List fileUrls = default(List), bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), SubSignerExperience signerExperience = default(SubSignerExperience)) { // to ensure "templateIds" is required (not null) @@ -88,6 +89,7 @@ protected SignatureRequestSendWithTemplateRequest() { } this.Subject = subject; this.TestMode = testMode; this.Title = title; + this.SignerExperience = signerExperience; } /// @@ -225,6 +227,12 @@ public static SignatureRequestSendWithTemplateRequest Init(string jsonData) [DataMember(Name = "title", EmitDefaultValue = true)] public string Title { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -250,6 +258,7 @@ public override string ToString() sb.Append(" Subject: ").Append(Subject).Append("\n"); sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -372,6 +381,11 @@ public bool Equals(SignatureRequestSendWithTemplateRequest input) this.Title == input.Title || (this.Title != null && this.Title.Equals(input.Title)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -440,6 +454,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Title.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -593,6 +611,13 @@ public List GetOpenApiTypes() Type = "string", Value = Title, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSignerExperience.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSignerExperience.cs new file mode 100644 index 000000000..01ad02278 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSignerExperience.cs @@ -0,0 +1,194 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + /// + [DataContract(Name = "SignatureRequestSignerExperience")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SignatureRequestSignerExperience : IEquatable, IValidatableObject + { + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + [JsonConverter(typeof(StringEnumConverter))] + public enum FormViewEnum + { + /// + /// Enum Disabled for value: disabled + /// + [EnumMember(Value = "disabled")] + Disabled = 1, + + /// + /// Enum Enabled for value: enabled + /// + [EnumMember(Value = "enabled")] + Enabled = 2, + + /// + /// Enum EnabledByDefault for value: enabled_by_default + /// + [EnumMember(Value = "enabled_by_default")] + EnabledByDefault = 3, + + /// + /// Enum Forced for value: forced + /// + [EnumMember(Value = "forced")] + Forced = 4 + } + + + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + [DataMember(Name = "form_view", IsRequired = true, EmitDefaultValue = true)] + public FormViewEnum FormView { get; set; } + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SignatureRequestSignerExperience() { } + /// + /// Initializes a new instance of the class. + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. (required). + public SignatureRequestSignerExperience(FormViewEnum formView = default(FormViewEnum)) + { + + this.FormView = formView; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SignatureRequestSignerExperience Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SignatureRequestSignerExperience"); + } + + return obj; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SignatureRequestSignerExperience {\n"); + sb.Append(" FormView: ").Append(FormView).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SignatureRequestSignerExperience); + } + + /// + /// Returns true if SignatureRequestSignerExperience instances are equal + /// + /// Instance of SignatureRequestSignerExperience to be compared + /// Boolean + public bool Equals(SignatureRequestSignerExperience input) + { + if (input == null) + { + return false; + } + return + ( + this.FormView == input.FormView || + this.FormView.Equals(input.FormView) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + hashCode = (hashCode * 59) + this.FormView.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "form_view", + Property = "FormView", + Type = "string", + Value = FormView, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubSignerExperience.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignerExperience.cs new file mode 100644 index 000000000..aaf2a9259 --- /dev/null +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubSignerExperience.cs @@ -0,0 +1,194 @@ +/* + * Dropbox Sign API + * + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.IO; +using System.Runtime.Serialization; +using System.Text; +using System.Text.RegularExpressions; +using Newtonsoft.Json; +using Newtonsoft.Json.Converters; +using Newtonsoft.Json.Linq; +using System.ComponentModel.DataAnnotations; +using OpenAPIDateConverter = Dropbox.Sign.Client.OpenAPIDateConverter; + +namespace Dropbox.Sign.Model +{ + /// + /// Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + /// + [DataContract(Name = "SubSignerExperience")] + [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] + public partial class SubSignerExperience : IEquatable, IValidatableObject + { + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + [JsonConverter(typeof(StringEnumConverter))] + public enum FormViewEnum + { + /// + /// Enum Disabled for value: disabled + /// + [EnumMember(Value = "disabled")] + Disabled = 1, + + /// + /// Enum Enabled for value: enabled + /// + [EnumMember(Value = "enabled")] + Enabled = 2, + + /// + /// Enum EnabledByDefault for value: enabled_by_default + /// + [EnumMember(Value = "enabled_by_default")] + EnabledByDefault = 3, + + /// + /// Enum Forced for value: forced + /// + [EnumMember(Value = "forced")] + Forced = 4 + } + + + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + [DataMember(Name = "form_view", EmitDefaultValue = true)] + public FormViewEnum? FormView { get; set; } + /// + /// Initializes a new instance of the class. + /// + [JsonConstructorAttribute] + protected SubSignerExperience() { } + /// + /// Initializes a new instance of the class. + /// + /// Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden.. + public SubSignerExperience(FormViewEnum? formView = default(FormViewEnum?)) + { + + this.FormView = formView; + } + + /// + /// Attempt to instantiate and hydrate a new instance of this class + /// + /// String of JSON data representing target object + public static SubSignerExperience Init(string jsonData) + { + var obj = JsonConvert.DeserializeObject(jsonData); + + if (obj == null) + { + throw new Exception("Unable to deserialize JSON to instance of SubSignerExperience"); + } + + return obj; + } + + /// + /// Returns the string presentation of the object + /// + /// String presentation of the object + public override string ToString() + { + StringBuilder sb = new StringBuilder(); + sb.Append("class SubSignerExperience {\n"); + sb.Append(" FormView: ").Append(FormView).Append("\n"); + sb.Append("}\n"); + return sb.ToString(); + } + + /// + /// Returns the JSON string presentation of the object + /// + /// JSON string presentation of the object + public virtual string ToJson() + { + return Newtonsoft.Json.JsonConvert.SerializeObject(this, Newtonsoft.Json.Formatting.Indented); + } + + /// + /// Returns true if objects are equal + /// + /// Object to be compared + /// Boolean + public override bool Equals(object input) + { + return this.Equals(input as SubSignerExperience); + } + + /// + /// Returns true if SubSignerExperience instances are equal + /// + /// Instance of SubSignerExperience to be compared + /// Boolean + public bool Equals(SubSignerExperience input) + { + if (input == null) + { + return false; + } + return + ( + this.FormView == input.FormView || + this.FormView.Equals(input.FormView) + ); + } + + /// + /// Gets the hash code + /// + /// Hash code + public override int GetHashCode() + { + unchecked // Overflow is fine, just wrap + { + int hashCode = 41; + hashCode = (hashCode * 59) + this.FormView.GetHashCode(); + return hashCode; + } + } + + /// + /// To validate all properties of the instance + /// + /// Validation context + /// Validation Result + IEnumerable IValidatableObject.Validate(ValidationContext validationContext) + { + yield break; + } + public List GetOpenApiTypes() + { + var types = new List(); + types.Add(new OpenApiType() + { + Name = "form_view", + Property = "FormView", + Type = "string", + Value = FormView, + }); + + return types; + } + } + +} diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs index b38a569b8..e65e5388c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs @@ -45,7 +45,6 @@ protected TemplateCreateEmbeddedDraftRequest() { } /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. (default to true). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// The CC roles that must be assigned when using the template to send a signature request. /// Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. (required). @@ -67,7 +66,8 @@ protected TemplateCreateEmbeddedDraftRequest() { } /// Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). (default to false). - public TemplateCreateEmbeddedDraftRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowReassign = false, bool allowFormView = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), bool showPreview = false, bool showProgressStepper = true, List signerRoles = default(List), bool skipMeNow = false, string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) + /// signerExperience. + public TemplateCreateEmbeddedDraftRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), bool showPreview = false, bool showProgressStepper = true, List signerRoles = default(List), bool skipMeNow = false, string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false, SubSignerExperience signerExperience = default(SubSignerExperience)) { // to ensure "clientId" is required (not null) @@ -80,7 +80,6 @@ protected TemplateCreateEmbeddedDraftRequest() { } this.FileUrls = fileUrls; this.AllowCcs = allowCcs; this.AllowReassign = allowReassign; - this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcRoles = ccRoles; this.EditorOptions = editorOptions; @@ -101,6 +100,7 @@ protected TemplateCreateEmbeddedDraftRequest() { } this.TestMode = testMode; this.Title = title; this.UsePreexistingFields = usePreexistingFields; + this.SignerExperience = signerExperience; } /// @@ -154,13 +154,6 @@ public static TemplateCreateEmbeddedDraftRequest Init(string jsonData) [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] public bool AllowReassign { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// A list describing the attachments /// @@ -299,6 +292,12 @@ public static TemplateCreateEmbeddedDraftRequest Init(string jsonData) [DataMember(Name = "use_preexisting_fields", EmitDefaultValue = true)] public bool UsePreexistingFields { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -312,7 +311,6 @@ public override string ToString() sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowCcs: ").Append(AllowCcs).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" EditorOptions: ").Append(EditorOptions).Append("\n"); @@ -333,6 +331,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UsePreexistingFields: ").Append(UsePreexistingFields).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -393,10 +392,6 @@ public bool Equals(TemplateCreateEmbeddedDraftRequest input) this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -497,6 +492,11 @@ public bool Equals(TemplateCreateEmbeddedDraftRequest input) ( this.UsePreexistingFields == input.UsePreexistingFields || this.UsePreexistingFields.Equals(input.UsePreexistingFields) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -523,7 +523,6 @@ public override int GetHashCode() } hashCode = (hashCode * 59) + this.AllowCcs.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -583,6 +582,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UsePreexistingFields.GetHashCode(); + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -647,13 +650,6 @@ public List GetOpenApiTypes() Value = AllowReassign, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", @@ -793,6 +789,13 @@ public List GetOpenApiTypes() Type = "bool", Value = UsePreexistingFields, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs index 28ec223fc..4a9597d87 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs @@ -44,7 +44,6 @@ protected TemplateCreateRequest() { } /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// The CC roles that must be assigned when using the template to send a signature request. /// Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.. @@ -60,7 +59,8 @@ protected TemplateCreateRequest() { } /// Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). (default to false). - public TemplateCreateRequest(List files = default(List), List fileUrls = default(List), bool allowReassign = false, bool allowFormView = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signerRoles = default(List), string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) + /// signerExperience. + public TemplateCreateRequest(List files = default(List), List fileUrls = default(List), bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signerRoles = default(List), string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false, SubSignerExperience signerExperience = default(SubSignerExperience)) { // to ensure "formFieldsPerDocument" is required (not null) @@ -78,7 +78,6 @@ protected TemplateCreateRequest() { } this.Files = files; this.FileUrls = fileUrls; this.AllowReassign = allowReassign; - this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcRoles = ccRoles; this.ClientId = clientId; @@ -92,6 +91,7 @@ protected TemplateCreateRequest() { } this.TestMode = testMode; this.Title = title; this.UsePreexistingFields = usePreexistingFields; + this.SignerExperience = signerExperience; } /// @@ -145,13 +145,6 @@ public static TemplateCreateRequest Init(string jsonData) [DataMember(Name = "allow_reassign", EmitDefaultValue = true)] public bool AllowReassign { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// A list describing the attachments /// @@ -242,6 +235,12 @@ public static TemplateCreateRequest Init(string jsonData) [DataMember(Name = "use_preexisting_fields", EmitDefaultValue = true)] public bool UsePreexistingFields { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -255,7 +254,6 @@ public override string ToString() sb.Append(" Files: ").Append(Files).Append("\n"); sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); @@ -269,6 +267,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UsePreexistingFields: ").Append(UsePreexistingFields).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -332,10 +331,6 @@ public bool Equals(TemplateCreateRequest input) this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -404,6 +399,11 @@ public bool Equals(TemplateCreateRequest input) ( this.UsePreexistingFields == input.UsePreexistingFields || this.UsePreexistingFields.Equals(input.UsePreexistingFields) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -433,7 +433,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -480,6 +479,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UsePreexistingFields.GetHashCode(); + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -544,13 +547,6 @@ public List GetOpenApiTypes() Value = AllowReassign, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", @@ -641,6 +637,13 @@ public List GetOpenApiTypes() Type = "bool", Value = UsePreexistingFields, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs index 5bca51acd..49eca4075 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs @@ -57,8 +57,8 @@ protected TemplateResponse() { } /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. /// An array of the Accounts that can use this Template.. /// Signer attachments.. - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.. - public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Dictionary metadata = default(Dictionary), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List), List attachments = default(List), bool allowFormView = default(bool)) + /// signerExperience. + public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Dictionary metadata = default(Dictionary), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List), List attachments = default(List), SignatureRequestSignerExperience signerExperience = default(SignatureRequestSignerExperience)) { this.TemplateId = templateId; @@ -77,7 +77,7 @@ protected TemplateResponse() { } this.NamedFormFields = namedFormFields; this.Accounts = accounts; this.Attachments = attachments; - this.AllowFormView = allowFormView; + this.SignerExperience = signerExperience; } /// @@ -211,11 +211,10 @@ public static TemplateResponse Init(string jsonData) public List Attachments { get; set; } /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + /// Gets or Sets SignerExperience /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SignatureRequestSignerExperience SignerExperience { get; set; } /// /// Returns the string presentation of the object @@ -241,7 +240,7 @@ public override string ToString() sb.Append(" NamedFormFields: ").Append(NamedFormFields).Append("\n"); sb.Append(" Accounts: ").Append(Accounts).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -362,8 +361,9 @@ public bool Equals(TemplateResponse input) this.Attachments.SequenceEqual(input.Attachments) ) && ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -428,7 +428,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); } - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -559,10 +562,10 @@ public List GetOpenApiTypes() }); types.Add(new OpenApiType() { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, + Name = "signer_experience", + Property = "SignerExperience", + Type = "SignatureRequestSignerExperience", + Value = SignerExperience, }); return types; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateRequest.cs index e5cfe892a..98589912a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateRequest.cs @@ -42,20 +42,20 @@ protected TemplateUpdateRequest() { } /// Initializes a new instance of the class. /// /// The CC roles that must be assigned when using the template to send a signature request.. - /// The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names.. /// The title you want to assign to the SignatureRequest.. /// The new default template email subject.. /// The new default template email message.. /// A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.. - public TemplateUpdateRequest(List ccRoles = default(List), bool allowFormView = default(bool), string title = default(string), string subject = default(string), string message = default(string), List formFields = default(List)) + /// signerExperience. + public TemplateUpdateRequest(List ccRoles = default(List), string title = default(string), string subject = default(string), string message = default(string), List formFields = default(List), SubSignerExperience signerExperience = default(SubSignerExperience)) { this.CcRoles = ccRoles; - this.AllowFormView = allowFormView; this.Title = title; this.Subject = subject; this.Message = message; this.FormFields = formFields; + this.SignerExperience = signerExperience; } /// @@ -81,13 +81,6 @@ public static TemplateUpdateRequest Init(string jsonData) [DataMember(Name = "cc_roles", EmitDefaultValue = true)] public List CcRoles { get; set; } - /// - /// The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. - /// - /// The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// The title you want to assign to the SignatureRequest. /// @@ -116,6 +109,12 @@ public static TemplateUpdateRequest Init(string jsonData) [DataMember(Name = "form_fields", EmitDefaultValue = true)] public List FormFields { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -125,11 +124,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TemplateUpdateRequest {\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" Subject: ").Append(Subject).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); sb.Append(" FormFields: ").Append(FormFields).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -171,10 +170,6 @@ public bool Equals(TemplateUpdateRequest input) input.CcRoles != null && this.CcRoles.SequenceEqual(input.CcRoles) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.Title == input.Title || (this.Title != null && @@ -195,6 +190,11 @@ public bool Equals(TemplateUpdateRequest input) this.FormFields != null && input.FormFields != null && this.FormFields.SequenceEqual(input.FormFields) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -211,7 +211,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.CcRoles.GetHashCode(); } - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Title != null) { hashCode = (hashCode * 59) + this.Title.GetHashCode(); @@ -228,6 +227,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.FormFields.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -264,13 +267,6 @@ public List GetOpenApiTypes() Value = CcRoles, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "title", Property = "Title", @@ -298,6 +294,13 @@ public List GetOpenApiTypes() Type = "List", Value = FormFields, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs index bc8f9faef..00ece6767 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs @@ -72,7 +72,6 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. (default to true). /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. (default to false). /// A list describing the attachments. /// The email addresses that should be CCed.. @@ -105,7 +104,7 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.. - public UnclaimedDraftCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowDecline = false, bool allowFormView = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerPage = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = default(bool), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), bool testMode = false, TypeEnum? type = TypeEnum.RequestSignature, bool usePreexistingFields = false, bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public UnclaimedDraftCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerPage = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = default(bool), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), bool testMode = false, TypeEnum? type = TypeEnum.RequestSignature, bool usePreexistingFields = false, bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -124,7 +123,6 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } this.FileUrls = fileUrls; this.AllowCcs = allowCcs; this.AllowDecline = allowDecline; - this.AllowFormView = allowFormView; this.AllowReassign = allowReassign; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; @@ -215,13 +213,6 @@ public static UnclaimedDraftCreateEmbeddedRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. /// @@ -436,7 +427,6 @@ public override string ToString() sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowCcs: ").Append(AllowCcs).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" AllowReassign: ").Append(AllowReassign).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); @@ -532,10 +522,6 @@ public bool Equals(UnclaimedDraftCreateEmbeddedRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.AllowReassign == input.AllowReassign || this.AllowReassign.Equals(input.AllowReassign) @@ -709,7 +695,6 @@ public override int GetHashCode() } hashCode = (hashCode * 59) + this.AllowCcs.GetHashCode(); hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); hashCode = (hashCode * 59) + this.AllowReassign.GetHashCode(); if (this.Attachments != null) { @@ -859,13 +844,6 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "allow_reassign", Property = "AllowReassign", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs index cbb15270e..7b1f20877 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs @@ -71,7 +71,6 @@ protected UnclaimedDraftCreateRequest() { } /// Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.. /// Allows signers to decline to sign a document if `true`. Defaults to `false`. (default to false). - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. (default to false). /// A list describing the attachments. /// The email addresses that should be CCed.. /// Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.. @@ -93,14 +92,14 @@ protected UnclaimedDraftCreateRequest() { } /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.. - public UnclaimedDraftCreateRequest(List files = default(List), List fileUrls = default(List), bool allowDecline = false, bool allowFormView = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, TypeEnum type = default(TypeEnum), bool usePreexistingFields = false, bool useTextTags = false, int? expiresAt = default(int?)) + /// signerExperience. + public UnclaimedDraftCreateRequest(List files = default(List), List fileUrls = default(List), bool allowDecline = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, TypeEnum type = default(TypeEnum), bool usePreexistingFields = false, bool useTextTags = false, int? expiresAt = default(int?), SubSignerExperience signerExperience = default(SubSignerExperience)) { this.Type = type; this.Files = files; this.FileUrls = fileUrls; this.AllowDecline = allowDecline; - this.AllowFormView = allowFormView; this.Attachments = attachments; this.CcEmailAddresses = ccEmailAddresses; this.ClientId = clientId; @@ -121,6 +120,7 @@ protected UnclaimedDraftCreateRequest() { } this.UsePreexistingFields = usePreexistingFields; this.UseTextTags = useTextTags; this.ExpiresAt = expiresAt; + this.SignerExperience = signerExperience; } /// @@ -160,13 +160,6 @@ public static UnclaimedDraftCreateRequest Init(string jsonData) [DataMember(Name = "allow_decline", EmitDefaultValue = true)] public bool AllowDecline { get; set; } - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - /// - /// Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - [DataMember(Name = "allow_form_view", EmitDefaultValue = true)] - public bool AllowFormView { get; set; } - /// /// A list describing the attachments /// @@ -305,6 +298,12 @@ public static UnclaimedDraftCreateRequest Init(string jsonData) [DataMember(Name = "expires_at", EmitDefaultValue = true)] public int? ExpiresAt { get; set; } + /// + /// Gets or Sets SignerExperience + /// + [DataMember(Name = "signer_experience", EmitDefaultValue = true)] + public SubSignerExperience SignerExperience { get; set; } + /// /// Returns the string presentation of the object /// @@ -317,7 +316,6 @@ public override string ToString() sb.Append(" Files: ").Append(Files).Append("\n"); sb.Append(" FileUrls: ").Append(FileUrls).Append("\n"); sb.Append(" AllowDecline: ").Append(AllowDecline).Append("\n"); - sb.Append(" AllowFormView: ").Append(AllowFormView).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" CcEmailAddresses: ").Append(CcEmailAddresses).Append("\n"); sb.Append(" ClientId: ").Append(ClientId).Append("\n"); @@ -338,6 +336,7 @@ public override string ToString() sb.Append(" UsePreexistingFields: ").Append(UsePreexistingFields).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); + sb.Append(" SignerExperience: ").Append(SignerExperience).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -393,10 +392,6 @@ public bool Equals(UnclaimedDraftCreateRequest input) this.AllowDecline == input.AllowDecline || this.AllowDecline.Equals(input.AllowDecline) ) && - ( - this.AllowFormView == input.AllowFormView || - this.AllowFormView.Equals(input.AllowFormView) - ) && ( this.Attachments == input.Attachments || this.Attachments != null && @@ -499,6 +494,11 @@ public bool Equals(UnclaimedDraftCreateRequest input) this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && this.ExpiresAt.Equals(input.ExpiresAt)) + ) && + ( + this.SignerExperience == input.SignerExperience || + (this.SignerExperience != null && + this.SignerExperience.Equals(input.SignerExperience)) ); } @@ -521,7 +521,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.FileUrls.GetHashCode(); } hashCode = (hashCode * 59) + this.AllowDecline.GetHashCode(); - hashCode = (hashCode * 59) + this.AllowFormView.GetHashCode(); if (this.Attachments != null) { hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); @@ -587,6 +586,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); } + if (this.SignerExperience != null) + { + hashCode = (hashCode * 59) + this.SignerExperience.GetHashCode(); + } return hashCode; } } @@ -644,13 +647,6 @@ public List GetOpenApiTypes() Value = AllowDecline, }); types.Add(new OpenApiType() - { - Name = "allow_form_view", - Property = "AllowFormView", - Type = "bool", - Value = AllowFormView, - }); - types.Add(new OpenApiType() { Name = "attachments", Property = "Attachments", @@ -790,6 +786,13 @@ public List GetOpenApiTypes() Type = "int?", Value = ExpiresAt, }); + types.Add(new OpenApiType() + { + Name = "signer_experience", + Property = "SignerExperience", + Type = "SubSignerExperience", + Value = SignerExperience, + }); return types; } diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index a0e36fb0f..a8cfba9cc 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -343,6 +343,7 @@ Class | Method | HTTP request | Description - [SignatureRequestResponseSignatures](docs/SignatureRequestResponseSignatures.md) - [SignatureRequestSendRequest](docs/SignatureRequestSendRequest.md) - [SignatureRequestSendWithTemplateRequest](docs/SignatureRequestSendWithTemplateRequest.md) + - [SignatureRequestSignerExperience](docs/SignatureRequestSignerExperience.md) - [SignatureRequestUpdateRequest](docs/SignatureRequestUpdateRequest.md) - [SubAttachment](docs/SubAttachment.md) - [SubBulkSignerList](docs/SubBulkSignerList.md) @@ -374,6 +375,7 @@ Class | Method | HTTP request | Description - [SubSignatureRequestGroupedSigners](docs/SubSignatureRequestGroupedSigners.md) - [SubSignatureRequestSigner](docs/SubSignatureRequestSigner.md) - [SubSignatureRequestTemplateSigner](docs/SubSignatureRequestTemplateSigner.md) + - [SubSignerExperience](docs/SubSignerExperience.md) - [SubSigningOptions](docs/SubSigningOptions.md) - [SubTeamResponse](docs/SubTeamResponse.md) - [SubTemplateRole](docs/SubTemplateRole.md) diff --git a/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md index 09809ea86..3fb02e144 100644 --- a/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/java-v1/docs/BulkSendJobGetResponseSignatureRequests.md @@ -33,6 +33,7 @@ | `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/EmbeddedEditUrlRequest.md b/sdks/java-v1/docs/EmbeddedEditUrlRequest.md index a6b29059c..c6b3f7218 100644 --- a/sdks/java-v1/docs/EmbeddedEditUrlRequest.md +++ b/sdks/java-v1/docs/EmbeddedEditUrlRequest.md @@ -9,7 +9,6 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `allowEditCcs` | ```Boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `forceSignerRoles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | | @@ -19,6 +18,7 @@ | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | | `testMode` | ```Boolean``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestApi.md b/sdks/java-v1/docs/SignatureRequestApi.md index 939b10ef3..61258f2e4 100644 --- a/sdks/java-v1/docs/SignatureRequestApi.md +++ b/sdks/java-v1/docs/SignatureRequestApi.md @@ -460,6 +460,9 @@ public class SignatureRequestCreateEmbeddedExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -489,6 +492,7 @@ public class SignatureRequestCreateEmbeddedExample new File("./example_signature_request.pdf") )); signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedRequest.signers(signers); try @@ -580,6 +584,9 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -598,6 +605,7 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); try @@ -694,6 +702,9 @@ public class SignatureRequestEditExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -729,6 +740,7 @@ public class SignatureRequestEditExample """, Map.class)); signatureRequestEditRequest.fieldOptions(fieldOptions); signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signerExperience(signerExperience); signatureRequestEditRequest.signers(signers); try @@ -824,6 +836,9 @@ public class SignatureRequestEditEmbeddedExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -853,6 +868,7 @@ public class SignatureRequestEditEmbeddedExample new File("./example_signature_request.pdf") )); signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedRequest.signers(signers); try @@ -948,6 +964,9 @@ public class SignatureRequestEditEmbeddedWithTemplateExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -966,6 +985,7 @@ public class SignatureRequestEditEmbeddedWithTemplateExample signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); try diff --git a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md index 9603d8c90..d92a9f99f 100644 --- a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md @@ -14,7 +14,6 @@ | `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | @@ -32,6 +31,7 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 050a7e631..0ed06b5e8 100644 --- a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -23,6 +23,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md index ff55ceb57..06a77f0dc 100644 --- a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md @@ -14,7 +14,6 @@ | `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | @@ -33,6 +32,7 @@ | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 3cc3dee72..965615451 100644 --- a/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -23,6 +23,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestEditRequest.md b/sdks/java-v1/docs/SignatureRequestEditRequest.md index fe879e3a8..efb8f5c0a 100644 --- a/sdks/java-v1/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditRequest.md @@ -13,7 +13,6 @@ | `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | @@ -34,6 +33,7 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md index d079524b1..9b93019cd 100644 --- a/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditWithTemplateRequest.md @@ -24,6 +24,7 @@ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestResponse.md b/sdks/java-v1/docs/SignatureRequestResponse.md index 6e8d9645c..dac0e2d70 100644 --- a/sdks/java-v1/docs/SignatureRequestResponse.md +++ b/sdks/java-v1/docs/SignatureRequestResponse.md @@ -33,6 +33,7 @@ Contains information about a signature request. | `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulkSendJobId` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestSendRequest.md b/sdks/java-v1/docs/SignatureRequestSendRequest.md index f55d3b2f4..8d8081803 100644 --- a/sdks/java-v1/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v1/docs/SignatureRequestSendRequest.md @@ -14,7 +14,6 @@ | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | @@ -35,6 +34,7 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md index 7a8d8c88a..e15507ca8 100644 --- a/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/java-v1/docs/SignatureRequestSendWithTemplateRequest.md @@ -25,6 +25,7 @@ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/SignatureRequestSignerExperience.md b/sdks/java-v1/docs/SignatureRequestSignerExperience.md new file mode 100644 index 000000000..c9beb1d18 --- /dev/null +++ b/sdks/java-v1/docs/SignatureRequestSignerExperience.md @@ -0,0 +1,25 @@ + + +# SignatureRequestSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `formView`*_required_ | [```FormViewEnum```](#FormViewEnum) | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + + + +## Enum: FormViewEnum + +| Name | Value | +---- | ----- +| DISABLED | "disabled" | +| ENABLED | "enabled" | +| ENABLED_BY_DEFAULT | "enabled_by_default" | +| FORCED | "forced" | + + + diff --git a/sdks/java-v1/docs/SubSignerExperience.md b/sdks/java-v1/docs/SubSignerExperience.md new file mode 100644 index 000000000..8d743fa6b --- /dev/null +++ b/sdks/java-v1/docs/SubSignerExperience.md @@ -0,0 +1,25 @@ + + +# SubSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `formView` | [```FormViewEnum```](#FormViewEnum) | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + + + +## Enum: FormViewEnum + +| Name | Value | +---- | ----- +| DISABLED | "disabled" | +| ENABLED | "enabled" | +| ENABLED_BY_DEFAULT | "enabled_by_default" | +| FORCED | "forced" | + + + diff --git a/sdks/java-v1/docs/TemplateApi.md b/sdks/java-v1/docs/TemplateApi.md index ad8f86a70..1ba2b4773 100644 --- a/sdks/java-v1/docs/TemplateApi.md +++ b/sdks/java-v1/docs/TemplateApi.md @@ -145,6 +145,9 @@ public class TemplateCreateExample var fieldOptions = new SubFieldOptions(); fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signerRoles1 = new SubTemplateRole(); signerRoles1.name("Client"); signerRoles1.order(0); @@ -217,6 +220,7 @@ public class TemplateCreateExample new File("./example_signature_request.pdf") )); templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerExperience(signerExperience); templateCreateRequest.signerRoles(signerRoles); templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); templateCreateRequest.mergeFields(mergeFields); @@ -1024,6 +1028,9 @@ public class TemplateUpdateExample ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var formFields1 = new SubUpdateFormField(); formFields1.apiId("uniqueIdHere_1"); formFields1.name("New name 1"); @@ -1038,7 +1045,6 @@ public class TemplateUpdateExample )); var templateUpdateRequest = new TemplateUpdateRequest(); - templateUpdateRequest.allowFormView(false); templateUpdateRequest.title("Test Title"); templateUpdateRequest.subject("Test Subject"); templateUpdateRequest.message("Test Message"); @@ -1046,6 +1052,7 @@ public class TemplateUpdateExample "CC Role 1", "CC Role 2" )); + templateUpdateRequest.signerExperience(signerExperience); templateUpdateRequest.formFields(formFields); try diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md index 40b9e6ca6..52f02f9a2 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md @@ -13,7 +13,6 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -34,6 +33,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/TemplateCreateRequest.md b/sdks/java-v1/docs/TemplateCreateRequest.md index 49525aa4c..895f63610 100644 --- a/sdks/java-v1/docs/TemplateCreateRequest.md +++ b/sdks/java-v1/docs/TemplateCreateRequest.md @@ -13,7 +13,6 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `clientId` | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | @@ -27,6 +26,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponse.md b/sdks/java-v1/docs/TemplateResponse.md index 9eaa7438e..32858edee 100644 --- a/sdks/java-v1/docs/TemplateResponse.md +++ b/sdks/java-v1/docs/TemplateResponse.md @@ -24,7 +24,7 @@ Contains information about the templates you and your team have created. | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/TemplateUpdateRequest.md b/sdks/java-v1/docs/TemplateUpdateRequest.md index 56d80eced..2162ed433 100644 --- a/sdks/java-v1/docs/TemplateUpdateRequest.md +++ b/sdks/java-v1/docs/TemplateUpdateRequest.md @@ -9,11 +9,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request. | | -| `allowFormView` | ```Boolean``` | The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `subject` | ```String``` | The new default template email subject. | | | `message` | ```String``` | The new default template email message. | | | `formFields` | [```List```](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md index b8d496953..aab362d77 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -14,7 +14,6 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md index 852847b61..b761f4b2f 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md @@ -12,7 +12,6 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | @@ -33,6 +32,7 @@ | `usePreexistingFields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `useTextTags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java index dc04b97e4..7c62222da 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java @@ -51,7 +51,8 @@ BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_ATTACHMENTS, BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_RESPONSE_DATA, BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_SIGNATURES, - BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_BULK_SEND_JOB_ID + BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_BULK_SEND_JOB_ID, + BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -134,6 +135,9 @@ public class BulkSendJobGetResponseSignatureRequests { public static final String JSON_PROPERTY_BULK_SEND_JOB_ID = "bulk_send_job_id"; @javax.annotation.Nullable private String bulkSendJobId; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SignatureRequestSignerExperience signerExperience; + public BulkSendJobGetResponseSignatureRequests() {} /** @@ -804,6 +808,30 @@ public void setBulkSendJobId(@javax.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } + public BulkSendJobGetResponseSignatureRequests signerExperience( + @javax.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SignatureRequestSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this BulkSendJobGetResponseSignatureRequests object is equal to o. */ @Override public boolean equals(Object o) { @@ -859,7 +887,10 @@ public boolean equals(Object o) { && Objects.equals( this.signatures, bulkSendJobGetResponseSignatureRequests.signatures) && Objects.equals( - this.bulkSendJobId, bulkSendJobGetResponseSignatureRequests.bulkSendJobId); + this.bulkSendJobId, bulkSendJobGetResponseSignatureRequests.bulkSendJobId) + && Objects.equals( + this.signerExperience, + bulkSendJobGetResponseSignatureRequests.signerExperience); } @Override @@ -889,7 +920,8 @@ public int hashCode() { attachments, responseData, signatures, - bulkSendJobId); + bulkSendJobId, + signerExperience); } @Override @@ -927,6 +959,7 @@ public String toString() { sb.append(" responseData: ").append(toIndentedString(responseData)).append("\n"); sb.append(" signatures: ").append(toIndentedString(signatures)).append("\n"); sb.append(" bulkSendJobId: ").append(toIndentedString(bulkSendJobId)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1435,6 +1468,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(bulkSendJobId)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java index a1628c72d..ed4ffc941 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java @@ -28,7 +28,6 @@ /** EmbeddedEditUrlRequest */ @JsonPropertyOrder({ EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_EDIT_CCS, - EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, EmbeddedEditUrlRequest.JSON_PROPERTY_CC_ROLES, EmbeddedEditUrlRequest.JSON_PROPERTY_EDITOR_OPTIONS, EmbeddedEditUrlRequest.JSON_PROPERTY_FORCE_SIGNER_ROLES, @@ -37,7 +36,8 @@ EmbeddedEditUrlRequest.JSON_PROPERTY_PREVIEW_ONLY, EmbeddedEditUrlRequest.JSON_PROPERTY_SHOW_PREVIEW, EmbeddedEditUrlRequest.JSON_PROPERTY_SHOW_PROGRESS_STEPPER, - EmbeddedEditUrlRequest.JSON_PROPERTY_TEST_MODE + EmbeddedEditUrlRequest.JSON_PROPERTY_TEST_MODE, + EmbeddedEditUrlRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -47,9 +47,6 @@ public class EmbeddedEditUrlRequest { public static final String JSON_PROPERTY_ALLOW_EDIT_CCS = "allow_edit_ccs"; @javax.annotation.Nullable private Boolean allowEditCcs = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; @javax.annotation.Nullable private List ccRoles = null; @@ -77,6 +74,9 @@ public class EmbeddedEditUrlRequest { public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; @javax.annotation.Nullable private Boolean testMode = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public EmbeddedEditUrlRequest() {} /** @@ -117,29 +117,6 @@ public void setAllowEditCcs(@javax.annotation.Nullable Boolean allowEditCcs) { this.allowEditCcs = allowEditCcs; } - public EmbeddedEditUrlRequest allowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public EmbeddedEditUrlRequest ccRoles(@javax.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; @@ -366,6 +343,30 @@ public void setTestMode(@javax.annotation.Nullable Boolean testMode) { this.testMode = testMode; } + public EmbeddedEditUrlRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this EmbeddedEditUrlRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -377,7 +378,6 @@ public boolean equals(Object o) { } EmbeddedEditUrlRequest embeddedEditUrlRequest = (EmbeddedEditUrlRequest) o; return Objects.equals(this.allowEditCcs, embeddedEditUrlRequest.allowEditCcs) - && Objects.equals(this.allowFormView, embeddedEditUrlRequest.allowFormView) && Objects.equals(this.ccRoles, embeddedEditUrlRequest.ccRoles) && Objects.equals(this.editorOptions, embeddedEditUrlRequest.editorOptions) && Objects.equals(this.forceSignerRoles, embeddedEditUrlRequest.forceSignerRoles) @@ -388,14 +388,14 @@ public boolean equals(Object o) { && Objects.equals(this.showPreview, embeddedEditUrlRequest.showPreview) && Objects.equals( this.showProgressStepper, embeddedEditUrlRequest.showProgressStepper) - && Objects.equals(this.testMode, embeddedEditUrlRequest.testMode); + && Objects.equals(this.testMode, embeddedEditUrlRequest.testMode) + && Objects.equals(this.signerExperience, embeddedEditUrlRequest.signerExperience); } @Override public int hashCode() { return Objects.hash( allowEditCcs, - allowFormView, ccRoles, editorOptions, forceSignerRoles, @@ -404,7 +404,8 @@ public int hashCode() { previewOnly, showPreview, showProgressStepper, - testMode); + testMode, + signerExperience); } @Override @@ -412,7 +413,6 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class EmbeddedEditUrlRequest {\n"); sb.append(" allowEditCcs: ").append(toIndentedString(allowEditCcs)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); sb.append(" forceSignerRoles: ").append(toIndentedString(forceSignerRoles)).append("\n"); @@ -426,6 +426,7 @@ public String toString() { .append(toIndentedString(showProgressStepper)) .append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -454,26 +455,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowEditCcs)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (ccRoles != null) { if (isFileTypeOrListOfFiles(ccRoles)) { fileTypeFound = true; @@ -656,6 +637,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(testMode)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 584b42cb2..bcdd67577 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java @@ -34,7 +34,6 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, - SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -52,6 +51,7 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_SIGNER_EXPERIENCE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @javax.annotation.Generated( @@ -78,9 +78,6 @@ public class SignatureRequestCreateEmbeddedRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -134,6 +131,9 @@ public class SignatureRequestCreateEmbeddedRequest { "populate_auto_fill_fields"; @javax.annotation.Nullable private Boolean populateAutoFillFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; @@ -335,30 +335,6 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestCreateEmbeddedRequest allowFormView( - @javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public SignatureRequestCreateEmbeddedRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -858,6 +834,30 @@ public void setPopulateAutoFillFields( this.populateAutoFillFields = populateAutoFillFields; } + public SignatureRequestCreateEmbeddedRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + public SignatureRequestCreateEmbeddedRequest expiresAt( @javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; @@ -902,8 +902,6 @@ public boolean equals(Object o) { this.groupedSigners, signatureRequestCreateEmbeddedRequest.groupedSigners) && Objects.equals( this.allowDecline, signatureRequestCreateEmbeddedRequest.allowDecline) - && Objects.equals( - this.allowFormView, signatureRequestCreateEmbeddedRequest.allowFormView) && Objects.equals( this.allowReassign, signatureRequestCreateEmbeddedRequest.allowReassign) && Objects.equals( @@ -936,6 +934,9 @@ public boolean equals(Object o) { && Objects.equals( this.populateAutoFillFields, signatureRequestCreateEmbeddedRequest.populateAutoFillFields) + && Objects.equals( + this.signerExperience, + signatureRequestCreateEmbeddedRequest.signerExperience) && Objects.equals(this.expiresAt, signatureRequestCreateEmbeddedRequest.expiresAt); } @@ -948,7 +949,6 @@ public int hashCode() { signers, groupedSigners, allowDecline, - allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -966,6 +966,7 @@ public int hashCode() { title, useTextTags, populateAutoFillFields, + signerExperience, expiresAt); } @@ -979,7 +980,6 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1001,6 +1001,7 @@ public String toString() { sb.append(" populateAutoFillFields: ") .append(toIndentedString(populateAutoFillFields)) .append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1126,26 +1127,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; @@ -1486,6 +1467,26 @@ public Map createFormData() throws ApiException { .writeValueAsString(populateAutoFillFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java index a6b8c00ec..8981dda8a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java @@ -42,7 +42,8 @@ SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, - SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS + SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -97,6 +98,9 @@ public class SignatureRequestCreateEmbeddedWithTemplateRequest { "populate_auto_fill_fields"; @javax.annotation.Nullable private Boolean populateAutoFillFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public SignatureRequestCreateEmbeddedWithTemplateRequest() {} /** @@ -543,6 +547,30 @@ public void setPopulateAutoFillFields( this.populateAutoFillFields = populateAutoFillFields; } + public SignatureRequestCreateEmbeddedWithTemplateRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** * Return true if this SignatureRequestCreateEmbeddedWithTemplateRequest object is equal to o. */ @@ -590,7 +618,10 @@ public boolean equals(Object o) { this.title, signatureRequestCreateEmbeddedWithTemplateRequest.title) && Objects.equals( this.populateAutoFillFields, - signatureRequestCreateEmbeddedWithTemplateRequest.populateAutoFillFields); + signatureRequestCreateEmbeddedWithTemplateRequest.populateAutoFillFields) + && Objects.equals( + this.signerExperience, + signatureRequestCreateEmbeddedWithTemplateRequest.signerExperience); } @Override @@ -610,7 +641,8 @@ public int hashCode() { subject, testMode, title, - populateAutoFillFields); + populateAutoFillFields, + signerExperience); } @Override @@ -634,6 +666,7 @@ public String toString() { sb.append(" populateAutoFillFields: ") .append(toIndentedString(populateAutoFillFields)) .append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -932,6 +965,26 @@ public Map createFormData() throws ApiException { .writeValueAsString(populateAutoFillFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index d6a528648..816eea438 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -34,7 +34,6 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, - SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -52,7 +51,8 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, - SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -78,9 +78,6 @@ public class SignatureRequestEditEmbeddedRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -137,6 +134,9 @@ public class SignatureRequestEditEmbeddedRequest { public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public SignatureRequestEditEmbeddedRequest() {} /** @@ -333,30 +333,6 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestEditEmbeddedRequest allowFormView( - @javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public SignatureRequestEditEmbeddedRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -879,6 +855,30 @@ public void setExpiresAt(@javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } + public SignatureRequestEditEmbeddedRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this SignatureRequestEditEmbeddedRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -898,8 +898,6 @@ public boolean equals(Object o) { this.groupedSigners, signatureRequestEditEmbeddedRequest.groupedSigners) && Objects.equals( this.allowDecline, signatureRequestEditEmbeddedRequest.allowDecline) - && Objects.equals( - this.allowFormView, signatureRequestEditEmbeddedRequest.allowFormView) && Objects.equals( this.allowReassign, signatureRequestEditEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditEmbeddedRequest.attachments) @@ -929,7 +927,10 @@ public boolean equals(Object o) { && Objects.equals( this.populateAutoFillFields, signatureRequestEditEmbeddedRequest.populateAutoFillFields) - && Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt); + && Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt) + && Objects.equals( + this.signerExperience, + signatureRequestEditEmbeddedRequest.signerExperience); } @Override @@ -941,7 +942,6 @@ public int hashCode() { signers, groupedSigners, allowDecline, - allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -959,7 +959,8 @@ public int hashCode() { title, useTextTags, populateAutoFillFields, - expiresAt); + expiresAt, + signerExperience); } @Override @@ -972,7 +973,6 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -995,6 +995,7 @@ public String toString() { .append(toIndentedString(populateAutoFillFields)) .append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1119,26 +1120,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; @@ -1499,6 +1480,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java index 6cd3dbed4..7cd3442cd 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java @@ -42,7 +42,8 @@ SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, - SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -97,6 +98,9 @@ public class SignatureRequestEditEmbeddedWithTemplateRequest { "populate_auto_fill_fields"; @javax.annotation.Nullable private Boolean populateAutoFillFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public SignatureRequestEditEmbeddedWithTemplateRequest() {} /** @@ -543,6 +547,30 @@ public void setPopulateAutoFillFields( this.populateAutoFillFields = populateAutoFillFields; } + public SignatureRequestEditEmbeddedWithTemplateRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this SignatureRequestEditEmbeddedWithTemplateRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -586,7 +614,10 @@ public boolean equals(Object o) { && Objects.equals(this.title, signatureRequestEditEmbeddedWithTemplateRequest.title) && Objects.equals( this.populateAutoFillFields, - signatureRequestEditEmbeddedWithTemplateRequest.populateAutoFillFields); + signatureRequestEditEmbeddedWithTemplateRequest.populateAutoFillFields) + && Objects.equals( + this.signerExperience, + signatureRequestEditEmbeddedWithTemplateRequest.signerExperience); } @Override @@ -606,7 +637,8 @@ public int hashCode() { subject, testMode, title, - populateAutoFillFields); + populateAutoFillFields, + signerExperience); } @Override @@ -630,6 +662,7 @@ public String toString() { sb.append(" populateAutoFillFields: ") .append(toIndentedString(populateAutoFillFields)) .append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -928,6 +961,26 @@ public Map createFormData() throws ApiException { .writeValueAsString(populateAutoFillFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 9fa77a0d9..712d9d226 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -33,7 +33,6 @@ SignatureRequestEditRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_DECLINE, - SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -53,7 +52,8 @@ SignatureRequestEditRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditRequest.JSON_PROPERTY_TITLE, SignatureRequestEditRequest.JSON_PROPERTY_USE_TEXT_TAGS, - SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT + SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -76,9 +76,6 @@ public class SignatureRequestEditRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -140,6 +137,9 @@ public class SignatureRequestEditRequest { public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public SignatureRequestEditRequest() {} /** @@ -310,30 +310,6 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestEditRequest allowFormView( - @javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public SignatureRequestEditRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -895,6 +871,30 @@ public void setExpiresAt(@javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } + public SignatureRequestEditRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this SignatureRequestEditRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -910,7 +910,6 @@ public boolean equals(Object o) { && Objects.equals(this.signers, signatureRequestEditRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestEditRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestEditRequest.allowDecline) - && Objects.equals(this.allowFormView, signatureRequestEditRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestEditRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditRequest.attachments) && Objects.equals( @@ -934,7 +933,9 @@ public boolean equals(Object o) { && Objects.equals(this.testMode, signatureRequestEditRequest.testMode) && Objects.equals(this.title, signatureRequestEditRequest.title) && Objects.equals(this.useTextTags, signatureRequestEditRequest.useTextTags) - && Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt); + && Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt) + && Objects.equals( + this.signerExperience, signatureRequestEditRequest.signerExperience); } @Override @@ -945,7 +946,6 @@ public int hashCode() { signers, groupedSigners, allowDecline, - allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -965,7 +965,8 @@ public int hashCode() { testMode, title, useTextTags, - expiresAt); + expiresAt, + signerExperience); } @Override @@ -977,7 +978,6 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1002,6 +1002,7 @@ public String toString() { sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1106,26 +1107,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; @@ -1522,6 +1503,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java index c49c66ff3..b4a006b35 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java @@ -43,7 +43,8 @@ SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -100,6 +101,9 @@ public class SignatureRequestEditWithTemplateRequest { public static final String JSON_PROPERTY_TITLE = "title"; @javax.annotation.Nullable private String title; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public SignatureRequestEditWithTemplateRequest() {} /** @@ -561,6 +565,30 @@ public void setTitle(@javax.annotation.Nullable String title) { this.title = title; } + public SignatureRequestEditWithTemplateRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this SignatureRequestEditWithTemplateRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -592,7 +620,10 @@ public boolean equals(Object o) { signatureRequestEditWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestEditWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestEditWithTemplateRequest.testMode) - && Objects.equals(this.title, signatureRequestEditWithTemplateRequest.title); + && Objects.equals(this.title, signatureRequestEditWithTemplateRequest.title) + && Objects.equals( + this.signerExperience, + signatureRequestEditWithTemplateRequest.signerExperience); } @Override @@ -613,7 +644,8 @@ public int hashCode() { signingRedirectUrl, subject, testMode, - title); + title, + signerExperience); } @Override @@ -638,6 +670,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -952,6 +985,26 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java index 85da7fb61..4740401be 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java @@ -51,7 +51,8 @@ SignatureRequestResponse.JSON_PROPERTY_ATTACHMENTS, SignatureRequestResponse.JSON_PROPERTY_RESPONSE_DATA, SignatureRequestResponse.JSON_PROPERTY_SIGNATURES, - SignatureRequestResponse.JSON_PROPERTY_BULK_SEND_JOB_ID + SignatureRequestResponse.JSON_PROPERTY_BULK_SEND_JOB_ID, + SignatureRequestResponse.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -134,6 +135,9 @@ public class SignatureRequestResponse { public static final String JSON_PROPERTY_BULK_SEND_JOB_ID = "bulk_send_job_id"; @javax.annotation.Nullable private String bulkSendJobId; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SignatureRequestSignerExperience signerExperience; + public SignatureRequestResponse() {} /** @@ -787,6 +791,30 @@ public void setBulkSendJobId(@javax.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } + public SignatureRequestResponse signerExperience( + @javax.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SignatureRequestSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this SignatureRequestResponse object is equal to o. */ @Override public boolean equals(Object o) { @@ -824,7 +852,8 @@ public boolean equals(Object o) { && Objects.equals(this.attachments, signatureRequestResponse.attachments) && Objects.equals(this.responseData, signatureRequestResponse.responseData) && Objects.equals(this.signatures, signatureRequestResponse.signatures) - && Objects.equals(this.bulkSendJobId, signatureRequestResponse.bulkSendJobId); + && Objects.equals(this.bulkSendJobId, signatureRequestResponse.bulkSendJobId) + && Objects.equals(this.signerExperience, signatureRequestResponse.signerExperience); } @Override @@ -854,7 +883,8 @@ public int hashCode() { attachments, responseData, signatures, - bulkSendJobId); + bulkSendJobId, + signerExperience); } @Override @@ -892,6 +922,7 @@ public String toString() { sb.append(" responseData: ").append(toIndentedString(responseData)).append("\n"); sb.append(" signatures: ").append(toIndentedString(signatures)).append("\n"); sb.append(" bulkSendJobId: ").append(toIndentedString(bulkSendJobId)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1400,6 +1431,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(bulkSendJobId)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index b12da8906..5507f4134 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -34,7 +34,6 @@ SignatureRequestSendRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_DECLINE, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_REASSIGN, - SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestSendRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestSendRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, SignatureRequestSendRequest.JSON_PROPERTY_CLIENT_ID, @@ -54,7 +53,8 @@ SignatureRequestSendRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestSendRequest.JSON_PROPERTY_TITLE, SignatureRequestSendRequest.JSON_PROPERTY_USE_TEXT_TAGS, - SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT + SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT, + SignatureRequestSendRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -80,9 +80,6 @@ public class SignatureRequestSendRequest { public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -144,6 +141,9 @@ public class SignatureRequestSendRequest { public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public SignatureRequestSendRequest() {} /** @@ -339,30 +339,6 @@ public void setAllowReassign(@javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public SignatureRequestSendRequest allowFormView( - @javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public SignatureRequestSendRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -930,6 +906,30 @@ public void setExpiresAt(@javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } + public SignatureRequestSendRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this SignatureRequestSendRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -946,7 +946,6 @@ public boolean equals(Object o) { && Objects.equals(this.groupedSigners, signatureRequestSendRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestSendRequest.allowDecline) && Objects.equals(this.allowReassign, signatureRequestSendRequest.allowReassign) - && Objects.equals(this.allowFormView, signatureRequestSendRequest.allowFormView) && Objects.equals(this.attachments, signatureRequestSendRequest.attachments) && Objects.equals( this.ccEmailAddresses, signatureRequestSendRequest.ccEmailAddresses) @@ -971,7 +970,9 @@ public boolean equals(Object o) { && Objects.equals(this.testMode, signatureRequestSendRequest.testMode) && Objects.equals(this.title, signatureRequestSendRequest.title) && Objects.equals(this.useTextTags, signatureRequestSendRequest.useTextTags) - && Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt); + && Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt) + && Objects.equals( + this.signerExperience, signatureRequestSendRequest.signerExperience); } @Override @@ -983,7 +984,6 @@ public int hashCode() { groupedSigners, allowDecline, allowReassign, - allowFormView, attachments, ccEmailAddresses, clientId, @@ -1003,7 +1003,8 @@ public int hashCode() { testMode, title, useTextTags, - expiresAt); + expiresAt, + signerExperience); } @Override @@ -1016,7 +1017,6 @@ public String toString() { sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1043,6 +1043,7 @@ public String toString() { sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1167,26 +1168,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1585,6 +1566,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java index eba4b1488..d366f91a4 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java @@ -44,7 +44,8 @@ SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -104,6 +105,9 @@ public class SignatureRequestSendWithTemplateRequest { public static final String JSON_PROPERTY_TITLE = "title"; @javax.annotation.Nullable private String title; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public SignatureRequestSendWithTemplateRequest() {} /** @@ -596,6 +600,30 @@ public void setTitle(@javax.annotation.Nullable String title) { this.title = title; } + public SignatureRequestSendWithTemplateRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this SignatureRequestSendWithTemplateRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -630,7 +658,10 @@ public boolean equals(Object o) { signatureRequestSendWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestSendWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestSendWithTemplateRequest.testMode) - && Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title); + && Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title) + && Objects.equals( + this.signerExperience, + signatureRequestSendWithTemplateRequest.signerExperience); } @Override @@ -652,7 +683,8 @@ public int hashCode() { signingRedirectUrl, subject, testMode, - title); + title, + signerExperience); } @Override @@ -680,6 +712,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1016,6 +1049,26 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSignerExperience.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSignerExperience.java new file mode 100644 index 000000000..f6ec097cc --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSignerExperience.java @@ -0,0 +1,226 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +/** + * Configuration options for modifying the settings of the signer application. Supports changing the + * form view behavior. + */ +@JsonPropertyOrder({SignatureRequestSignerExperience.JSON_PROPERTY_FORM_VIEW}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class SignatureRequestSignerExperience { + /** + * Changes the form view setting experienced by the signer. Supported versions are: - + * `disabled` - Form view is disabled, and the signer cannot change it - + * `enabled` - Form view is disabled initially, the signer can turn it on using a + * toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn + * it off using a toggle - `forced` - Form view is enabled initially. The signer + * cannot change it, the toggle is hidden. + */ + public enum FormViewEnum { + DISABLED(String.valueOf("disabled")), + + ENABLED(String.valueOf("enabled")), + + ENABLED_BY_DEFAULT(String.valueOf("enabled_by_default")), + + FORCED(String.valueOf("forced")); + + private String value; + + FormViewEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FormViewEnum fromValue(String value) { + for (FormViewEnum b : FormViewEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FORM_VIEW = "form_view"; + @javax.annotation.Nonnull private FormViewEnum formView; + + public SignatureRequestSignerExperience() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static SignatureRequestSignerExperience init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestSignerExperience.class); + } + + public static SignatureRequestSignerExperience init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestSignerExperience.class); + } + + public SignatureRequestSignerExperience formView( + @javax.annotation.Nonnull FormViewEnum formView) { + this.formView = formView; + return this; + } + + /** + * Changes the form view setting experienced by the signer. Supported versions are: - + * `disabled` - Form view is disabled, and the signer cannot change it - + * `enabled` - Form view is disabled initially, the signer can turn it on using a + * toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn + * it off using a toggle - `forced` - Form view is enabled initially. The signer + * cannot change it, the toggle is hidden. + * + * @return formView + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public FormViewEnum getFormView() { + return formView; + } + + @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFormView(@javax.annotation.Nonnull FormViewEnum formView) { + this.formView = formView; + } + + /** Return true if this SignatureRequestSignerExperience object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestSignerExperience signatureRequestSignerExperience = + (SignatureRequestSignerExperience) o; + return Objects.equals(this.formView, signatureRequestSignerExperience.formView); + } + + @Override + public int hashCode() { + return Objects.hash(formView); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestSignerExperience {\n"); + sb.append(" formView: ").append(toIndentedString(formView)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (formView != null) { + if (isFileTypeOrListOfFiles(formView)) { + fileTypeFound = true; + } + + if (formView.getClass().equals(java.io.File.class) + || formView.getClass().equals(Integer.class) + || formView.getClass().equals(String.class) + || formView.getClass().isEnum()) { + map.put("form_view", formView); + } else if (isListOfFile(formView)) { + for (int i = 0; i < getListSize(formView); i++) { + map.put("form_view[" + i + "]", getFromList(formView, i)); + } + } else { + map.put( + "form_view", + JSON.getDefault().getMapper().writeValueAsString(formView)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignerExperience.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignerExperience.java new file mode 100644 index 000000000..365e600cc --- /dev/null +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSignerExperience.java @@ -0,0 +1,221 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.dropbox.sign.model; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonValue; +import com.fasterxml.jackson.databind.ObjectMapper; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; + +/** + * Configuration options for modifying the settings of the signer application. Supports changing the + * form view behavior. + */ +@JsonPropertyOrder({SubSignerExperience.JSON_PROPERTY_FORM_VIEW}) +@javax.annotation.Generated( + value = "org.openapitools.codegen.languages.JavaClientCodegen", + comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown = true) +public class SubSignerExperience { + /** + * Changes the form view setting experienced by the signer. Supported versions are: - + * `disabled` - Form view is disabled, and the signer cannot change it - + * `enabled` - Form view is disabled initially, the signer can turn it on using a + * toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn + * it off using a toggle - `forced` - Form view is enabled initially. The signer + * cannot change it, the toggle is hidden. + */ + public enum FormViewEnum { + DISABLED(String.valueOf("disabled")), + + ENABLED(String.valueOf("enabled")), + + ENABLED_BY_DEFAULT(String.valueOf("enabled_by_default")), + + FORCED(String.valueOf("forced")); + + private String value; + + FormViewEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FormViewEnum fromValue(String value) { + for (FormViewEnum b : FormViewEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FORM_VIEW = "form_view"; + @javax.annotation.Nullable private FormViewEnum formView; + + public SubSignerExperience() {} + + /** + * Attempt to instantiate and hydrate a new instance of this class + * + * @param jsonData String of JSON data representing target object + */ + public static SubSignerExperience init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SubSignerExperience.class); + } + + public static SubSignerExperience init(HashMap data) throws Exception { + return new ObjectMapper() + .readValue(new ObjectMapper().writeValueAsString(data), SubSignerExperience.class); + } + + public SubSignerExperience formView(@javax.annotation.Nullable FormViewEnum formView) { + this.formView = formView; + return this; + } + + /** + * Changes the form view setting experienced by the signer. Supported versions are: - + * `disabled` - Form view is disabled, and the signer cannot change it - + * `enabled` - Form view is disabled initially, the signer can turn it on using a + * toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn + * it off using a toggle - `forced` - Form view is enabled initially. The signer + * cannot change it, the toggle is hidden. + * + * @return formView + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public FormViewEnum getFormView() { + return formView; + } + + @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormView(@javax.annotation.Nullable FormViewEnum formView) { + this.formView = formView; + } + + /** Return true if this SubSignerExperience object is equal to o. */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SubSignerExperience subSignerExperience = (SubSignerExperience) o; + return Objects.equals(this.formView, subSignerExperience.formView); + } + + @Override + public int hashCode() { + return Objects.hash(formView); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SubSignerExperience {\n"); + sb.append(" formView: ").append(toIndentedString(formView)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (formView != null) { + if (isFileTypeOrListOfFiles(formView)) { + fileTypeFound = true; + } + + if (formView.getClass().equals(java.io.File.class) + || formView.getClass().equals(Integer.class) + || formView.getClass().equals(String.class) + || formView.getClass().isEnum()) { + map.put("form_view", formView); + } else if (isListOfFile(formView)) { + for (int i = 0; i < getListSize(formView); i++) { + map.put("form_view[" + i + "]", getFromList(formView, i)); + } + } else { + map.put( + "form_view", + JSON.getDefault().getMapper().writeValueAsString(formView)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List + && !isListEmpty(obj) + && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) + Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()) + .getMethod("get", int.class) + .invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces (except the first + * line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index a57c84d16..45fcf0a7f 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java @@ -33,7 +33,6 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_CCS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_REASSIGN, - TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_EDITOR_OPTIONS, @@ -53,7 +52,8 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_SUBJECT, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TITLE, - TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -75,9 +75,6 @@ public class TemplateCreateEmbeddedDraftRequest { public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -139,6 +136,9 @@ public class TemplateCreateEmbeddedDraftRequest { public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; @javax.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public TemplateCreateEmbeddedDraftRequest() {} /** @@ -293,30 +293,6 @@ public void setAllowReassign(@javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public TemplateCreateEmbeddedDraftRequest allowFormView( - @javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public TemplateCreateEmbeddedDraftRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -878,6 +854,30 @@ public void setUsePreexistingFields(@javax.annotation.Nullable Boolean usePreexi this.usePreexistingFields = usePreexistingFields; } + public TemplateCreateEmbeddedDraftRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this TemplateCreateEmbeddedDraftRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -895,8 +895,6 @@ public boolean equals(Object o) { && Objects.equals(this.allowCcs, templateCreateEmbeddedDraftRequest.allowCcs) && Objects.equals( this.allowReassign, templateCreateEmbeddedDraftRequest.allowReassign) - && Objects.equals( - this.allowFormView, templateCreateEmbeddedDraftRequest.allowFormView) && Objects.equals(this.attachments, templateCreateEmbeddedDraftRequest.attachments) && Objects.equals(this.ccRoles, templateCreateEmbeddedDraftRequest.ccRoles) && Objects.equals( @@ -929,7 +927,9 @@ public boolean equals(Object o) { && Objects.equals(this.title, templateCreateEmbeddedDraftRequest.title) && Objects.equals( this.usePreexistingFields, - templateCreateEmbeddedDraftRequest.usePreexistingFields); + templateCreateEmbeddedDraftRequest.usePreexistingFields) + && Objects.equals( + this.signerExperience, templateCreateEmbeddedDraftRequest.signerExperience); } @Override @@ -940,7 +940,6 @@ public int hashCode() { fileUrls, allowCcs, allowReassign, - allowFormView, attachments, ccRoles, editorOptions, @@ -960,7 +959,8 @@ public int hashCode() { subject, testMode, title, - usePreexistingFields); + usePreexistingFields, + signerExperience); } @Override @@ -972,7 +972,6 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); @@ -1001,6 +1000,7 @@ public String toString() { sb.append(" usePreexistingFields: ") .append(toIndentedString(usePreexistingFields)) .append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1107,26 +1107,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1527,6 +1507,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index fee8ea562..875312dcf 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java @@ -33,7 +33,6 @@ TemplateCreateRequest.JSON_PROPERTY_FILES, TemplateCreateRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateRequest.JSON_PROPERTY_ALLOW_REASSIGN, - TemplateCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -46,7 +45,8 @@ TemplateCreateRequest.JSON_PROPERTY_SUBJECT, TemplateCreateRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateRequest.JSON_PROPERTY_TITLE, - TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -70,9 +70,6 @@ public class TemplateCreateRequest { public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -112,6 +109,9 @@ public class TemplateCreateRequest { public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; @javax.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public TemplateCreateRequest() {} /** @@ -297,29 +297,6 @@ public void setAllowReassign(@javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public TemplateCreateRequest allowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public TemplateCreateRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -676,6 +653,30 @@ public void setUsePreexistingFields(@javax.annotation.Nullable Boolean usePreexi this.usePreexistingFields = usePreexistingFields; } + public TemplateCreateRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this TemplateCreateRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -692,7 +693,6 @@ public boolean equals(Object o) { && Objects.equals(this.files, templateCreateRequest.files) && Objects.equals(this.fileUrls, templateCreateRequest.fileUrls) && Objects.equals(this.allowReassign, templateCreateRequest.allowReassign) - && Objects.equals(this.allowFormView, templateCreateRequest.allowFormView) && Objects.equals(this.attachments, templateCreateRequest.attachments) && Objects.equals(this.ccRoles, templateCreateRequest.ccRoles) && Objects.equals(this.clientId, templateCreateRequest.clientId) @@ -706,7 +706,8 @@ public boolean equals(Object o) { && Objects.equals(this.testMode, templateCreateRequest.testMode) && Objects.equals(this.title, templateCreateRequest.title) && Objects.equals( - this.usePreexistingFields, templateCreateRequest.usePreexistingFields); + this.usePreexistingFields, templateCreateRequest.usePreexistingFields) + && Objects.equals(this.signerExperience, templateCreateRequest.signerExperience); } @Override @@ -717,7 +718,6 @@ public int hashCode() { files, fileUrls, allowReassign, - allowFormView, attachments, ccRoles, clientId, @@ -730,7 +730,8 @@ public int hashCode() { subject, testMode, title, - usePreexistingFields); + usePreexistingFields, + signerExperience); } @Override @@ -744,7 +745,6 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -760,6 +760,7 @@ public String toString() { sb.append(" usePreexistingFields: ") .append(toIndentedString(usePreexistingFields)) .append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -870,26 +871,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1142,6 +1123,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 3a940108d..6b31c072d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -43,7 +43,7 @@ TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, TemplateResponse.JSON_PROPERTY_ACCOUNTS, TemplateResponse.JSON_PROPERTY_ATTACHMENTS, - TemplateResponse.JSON_PROPERTY_ALLOW_FORM_VIEW + TemplateResponse.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -100,8 +100,8 @@ public class TemplateResponse { public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SignatureRequestSignerExperience signerExperience; public TemplateResponse() {} @@ -572,27 +572,28 @@ public void setAttachments( this.attachments = attachments; } - public TemplateResponse allowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; + public TemplateResponse signerExperience( + @javax.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; return this; } /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. + * Get signerExperience * - * @return allowFormView + * @return signerExperience */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; + public SignatureRequestSignerExperience getSignerExperience() { + return signerExperience; } - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; + public void setSignerExperience( + @javax.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; } /** Return true if this TemplateResponse object is equal to o. */ @@ -621,7 +622,7 @@ public boolean equals(Object o) { && Objects.equals(this.namedFormFields, templateResponse.namedFormFields) && Objects.equals(this.accounts, templateResponse.accounts) && Objects.equals(this.attachments, templateResponse.attachments) - && Objects.equals(this.allowFormView, templateResponse.allowFormView); + && Objects.equals(this.signerExperience, templateResponse.signerExperience); } @Override @@ -643,7 +644,7 @@ public int hashCode() { namedFormFields, accounts, attachments, - allowFormView); + signerExperience); } @Override @@ -666,7 +667,7 @@ public String toString() { sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -983,24 +984,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(attachments)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { fileTypeFound = true; } - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); } } else { map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); } } } catch (Exception e) { diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java index 7c76d4a2a..5201d49be 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java @@ -28,11 +28,11 @@ /** TemplateUpdateRequest */ @JsonPropertyOrder({ TemplateUpdateRequest.JSON_PROPERTY_CC_ROLES, - TemplateUpdateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateUpdateRequest.JSON_PROPERTY_TITLE, TemplateUpdateRequest.JSON_PROPERTY_SUBJECT, TemplateUpdateRequest.JSON_PROPERTY_MESSAGE, - TemplateUpdateRequest.JSON_PROPERTY_FORM_FIELDS + TemplateUpdateRequest.JSON_PROPERTY_FORM_FIELDS, + TemplateUpdateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -42,9 +42,6 @@ public class TemplateUpdateRequest { public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; @javax.annotation.Nullable private List ccRoles = null; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView; - public static final String JSON_PROPERTY_TITLE = "title"; @javax.annotation.Nullable private String title; @@ -57,6 +54,9 @@ public class TemplateUpdateRequest { public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; @javax.annotation.Nullable private List formFields = null; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public TemplateUpdateRequest() {} /** @@ -104,29 +104,6 @@ public void setCcRoles(@javax.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; } - public TemplateUpdateRequest allowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * The CC roles that must be assigned when using the template to send a signature request. If - * set to `true` all the form fields on template document must have non-empty names. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public TemplateUpdateRequest title(@javax.annotation.Nullable String title) { this.title = title; return this; @@ -226,6 +203,30 @@ public void setFormFields(@javax.annotation.Nullable List fo this.formFields = formFields; } + public TemplateUpdateRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this TemplateUpdateRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -237,16 +238,16 @@ public boolean equals(Object o) { } TemplateUpdateRequest templateUpdateRequest = (TemplateUpdateRequest) o; return Objects.equals(this.ccRoles, templateUpdateRequest.ccRoles) - && Objects.equals(this.allowFormView, templateUpdateRequest.allowFormView) && Objects.equals(this.title, templateUpdateRequest.title) && Objects.equals(this.subject, templateUpdateRequest.subject) && Objects.equals(this.message, templateUpdateRequest.message) - && Objects.equals(this.formFields, templateUpdateRequest.formFields); + && Objects.equals(this.formFields, templateUpdateRequest.formFields) + && Objects.equals(this.signerExperience, templateUpdateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(ccRoles, allowFormView, title, subject, message, formFields); + return Objects.hash(ccRoles, title, subject, message, formFields, signerExperience); } @Override @@ -254,11 +255,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateUpdateRequest {\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -285,26 +286,6 @@ public Map createFormData() throws ApiException { map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (title != null) { if (isFileTypeOrListOfFiles(title)) { fileTypeFound = true; @@ -379,6 +360,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(formFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index d3bd9a81d..4b758039a 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java @@ -36,7 +36,6 @@ UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_CCS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, - UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -91,9 +90,6 @@ public class UnclaimedDraftCreateEmbeddedRequest { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @javax.annotation.Nullable private Boolean allowReassign = false; @@ -400,30 +396,6 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public UnclaimedDraftCreateEmbeddedRequest allowFormView( - @javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public UnclaimedDraftCreateEmbeddedRequest allowReassign( @javax.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; @@ -1273,8 +1245,6 @@ public boolean equals(Object o) { && Objects.equals(this.allowCcs, unclaimedDraftCreateEmbeddedRequest.allowCcs) && Objects.equals( this.allowDecline, unclaimedDraftCreateEmbeddedRequest.allowDecline) - && Objects.equals( - this.allowFormView, unclaimedDraftCreateEmbeddedRequest.allowFormView) && Objects.equals( this.allowReassign, unclaimedDraftCreateEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, unclaimedDraftCreateEmbeddedRequest.attachments) @@ -1342,7 +1312,6 @@ public int hashCode() { fileUrls, allowCcs, allowDecline, - allowFormView, allowReassign, attachments, ccEmailAddresses, @@ -1387,7 +1356,6 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1564,26 +1532,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index cf104bb0f..19481b697 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java @@ -34,7 +34,6 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_FILES, UnclaimedDraftCreateRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_DECLINE, - UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, UnclaimedDraftCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -54,7 +53,8 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_TEST_MODE, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_TEXT_TAGS, - UnclaimedDraftCreateRequest.JSON_PROPERTY_EXPIRES_AT + UnclaimedDraftCreateRequest.JSON_PROPERTY_EXPIRES_AT, + UnclaimedDraftCreateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -110,9 +110,6 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; @javax.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @javax.annotation.Nullable private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @javax.annotation.Nullable private List attachments = null; @@ -174,6 +171,9 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @javax.annotation.Nullable private SubSignerExperience signerExperience; + public UnclaimedDraftCreateRequest() {} /** @@ -303,30 +303,6 @@ public void setAllowDecline(@javax.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public UnclaimedDraftCreateRequest allowFormView( - @javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to - * `false`. - * - * @return allowFormView - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getAllowFormView() { - return allowFormView; - } - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@javax.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - public UnclaimedDraftCreateRequest attachments( @javax.annotation.Nullable List attachments) { this.attachments = attachments; @@ -905,6 +881,30 @@ public void setExpiresAt(@javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } + public UnclaimedDraftCreateRequest signerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * + * @return signerExperience + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience( + @javax.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + /** Return true if this UnclaimedDraftCreateRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -919,7 +919,6 @@ public boolean equals(Object o) { && Objects.equals(this.files, unclaimedDraftCreateRequest.files) && Objects.equals(this.fileUrls, unclaimedDraftCreateRequest.fileUrls) && Objects.equals(this.allowDecline, unclaimedDraftCreateRequest.allowDecline) - && Objects.equals(this.allowFormView, unclaimedDraftCreateRequest.allowFormView) && Objects.equals(this.attachments, unclaimedDraftCreateRequest.attachments) && Objects.equals( this.ccEmailAddresses, unclaimedDraftCreateRequest.ccEmailAddresses) @@ -945,7 +944,9 @@ public boolean equals(Object o) { && Objects.equals( this.usePreexistingFields, unclaimedDraftCreateRequest.usePreexistingFields) && Objects.equals(this.useTextTags, unclaimedDraftCreateRequest.useTextTags) - && Objects.equals(this.expiresAt, unclaimedDraftCreateRequest.expiresAt); + && Objects.equals(this.expiresAt, unclaimedDraftCreateRequest.expiresAt) + && Objects.equals( + this.signerExperience, unclaimedDraftCreateRequest.signerExperience); } @Override @@ -955,7 +956,6 @@ public int hashCode() { files, fileUrls, allowDecline, - allowFormView, attachments, ccEmailAddresses, clientId, @@ -975,7 +975,8 @@ public int hashCode() { testMode, usePreexistingFields, useTextTags, - expiresAt); + expiresAt, + signerExperience); } @Override @@ -986,7 +987,6 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1015,6 +1015,7 @@ public String toString() { .append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1099,26 +1100,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) - || allowFormView.getClass().equals(Integer.class) - || allowFormView.getClass().equals(String.class) - || allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for (int i = 0; i < getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } else { - map.put( - "allow_form_view", - JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1521,6 +1502,26 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) + || signerExperience.getClass().equals(Integer.class) + || signerExperience.getClass().equals(String.class) + || signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for (int i = 0; i < getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } else { + map.put( + "signer_experience", + JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index 50f768ee5..457700187 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -319,6 +319,7 @@ Class | Method | HTTP request | Description - [SignatureRequestResponseSignatures](docs/SignatureRequestResponseSignatures.md) - [SignatureRequestSendRequest](docs/SignatureRequestSendRequest.md) - [SignatureRequestSendWithTemplateRequest](docs/SignatureRequestSendWithTemplateRequest.md) + - [SignatureRequestSignerExperience](docs/SignatureRequestSignerExperience.md) - [SignatureRequestUpdateRequest](docs/SignatureRequestUpdateRequest.md) - [SubAttachment](docs/SubAttachment.md) - [SubBulkSignerList](docs/SubBulkSignerList.md) @@ -350,6 +351,7 @@ Class | Method | HTTP request | Description - [SubSignatureRequestGroupedSigners](docs/SubSignatureRequestGroupedSigners.md) - [SubSignatureRequestSigner](docs/SubSignatureRequestSigner.md) - [SubSignatureRequestTemplateSigner](docs/SubSignatureRequestTemplateSigner.md) + - [SubSignerExperience](docs/SubSignerExperience.md) - [SubSigningOptions](docs/SubSigningOptions.md) - [SubTeamResponse](docs/SubTeamResponse.md) - [SubTemplateRole](docs/SubTemplateRole.md) diff --git a/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md index 09809ea86..3fb02e144 100644 --- a/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/java-v2/docs/BulkSendJobGetResponseSignatureRequests.md @@ -33,6 +33,7 @@ | `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/EmbeddedEditUrlRequest.md b/sdks/java-v2/docs/EmbeddedEditUrlRequest.md index a6b29059c..c6b3f7218 100644 --- a/sdks/java-v2/docs/EmbeddedEditUrlRequest.md +++ b/sdks/java-v2/docs/EmbeddedEditUrlRequest.md @@ -9,7 +9,6 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `allowEditCcs` | ```Boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `forceSignerRoles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | | @@ -19,6 +18,7 @@ | `showPreview` | ```Boolean``` | This allows the requester to enable the editor/preview experience. | | | `showProgressStepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | | | `testMode` | ```Boolean``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestApi.md b/sdks/java-v2/docs/SignatureRequestApi.md index 939b10ef3..61258f2e4 100644 --- a/sdks/java-v2/docs/SignatureRequestApi.md +++ b/sdks/java-v2/docs/SignatureRequestApi.md @@ -460,6 +460,9 @@ public class SignatureRequestCreateEmbeddedExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -489,6 +492,7 @@ public class SignatureRequestCreateEmbeddedExample new File("./example_signature_request.pdf") )); signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedRequest.signers(signers); try @@ -580,6 +584,9 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -598,6 +605,7 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); try @@ -694,6 +702,9 @@ public class SignatureRequestEditExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -729,6 +740,7 @@ public class SignatureRequestEditExample """, Map.class)); signatureRequestEditRequest.fieldOptions(fieldOptions); signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signerExperience(signerExperience); signatureRequestEditRequest.signers(signers); try @@ -824,6 +836,9 @@ public class SignatureRequestEditEmbeddedExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); signers1.emailAddress("jack@example.com"); @@ -853,6 +868,7 @@ public class SignatureRequestEditEmbeddedExample new File("./example_signature_request.pdf") )); signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedRequest.signers(signers); try @@ -948,6 +964,9 @@ public class SignatureRequestEditEmbeddedWithTemplateExample signingOptions.type(true); signingOptions.upload(true); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); signers1.name("George"); @@ -966,6 +985,7 @@ public class SignatureRequestEditEmbeddedWithTemplateExample signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signerExperience(signerExperience); signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); try diff --git a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md index 9603d8c90..d92a9f99f 100644 --- a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md @@ -14,7 +14,6 @@ | `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | @@ -32,6 +31,7 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 050a7e631..0ed06b5e8 100644 --- a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -23,6 +23,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md index ff55ceb57..06a77f0dc 100644 --- a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md @@ -14,7 +14,6 @@ | `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | @@ -33,6 +32,7 @@ | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 3cc3dee72..965615451 100644 --- a/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -23,6 +23,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestEditRequest.md b/sdks/java-v2/docs/SignatureRequestEditRequest.md index fe879e3a8..efb8f5c0a 100644 --- a/sdks/java-v2/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditRequest.md @@ -13,7 +13,6 @@ | `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | @@ -34,6 +33,7 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md index d079524b1..9b93019cd 100644 --- a/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditWithTemplateRequest.md @@ -24,6 +24,7 @@ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestResponse.md b/sdks/java-v2/docs/SignatureRequestResponse.md index 6e8d9645c..dac0e2d70 100644 --- a/sdks/java-v2/docs/SignatureRequestResponse.md +++ b/sdks/java-v2/docs/SignatureRequestResponse.md @@ -33,6 +33,7 @@ Contains information about a signature request. | `responseData` | [```List```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```List```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulkSendJobId` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestSendRequest.md b/sdks/java-v2/docs/SignatureRequestSendRequest.md index f55d3b2f4..8d8081803 100644 --- a/sdks/java-v2/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v2/docs/SignatureRequestSendRequest.md @@ -14,7 +14,6 @@ | `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | @@ -35,6 +34,7 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md index 7a8d8c88a..e15507ca8 100644 --- a/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/java-v2/docs/SignatureRequestSendWithTemplateRequest.md @@ -25,6 +25,7 @@ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/SignatureRequestSignerExperience.md b/sdks/java-v2/docs/SignatureRequestSignerExperience.md new file mode 100644 index 000000000..c9beb1d18 --- /dev/null +++ b/sdks/java-v2/docs/SignatureRequestSignerExperience.md @@ -0,0 +1,25 @@ + + +# SignatureRequestSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `formView`*_required_ | [```FormViewEnum```](#FormViewEnum) | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + + + +## Enum: FormViewEnum + +| Name | Value | +---- | ----- +| DISABLED | "disabled" | +| ENABLED | "enabled" | +| ENABLED_BY_DEFAULT | "enabled_by_default" | +| FORCED | "forced" | + + + diff --git a/sdks/java-v2/docs/SubSignerExperience.md b/sdks/java-v2/docs/SubSignerExperience.md new file mode 100644 index 000000000..8d743fa6b --- /dev/null +++ b/sdks/java-v2/docs/SubSignerExperience.md @@ -0,0 +1,25 @@ + + +# SubSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `formView` | [```FormViewEnum```](#FormViewEnum) | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + + + +## Enum: FormViewEnum + +| Name | Value | +---- | ----- +| DISABLED | "disabled" | +| ENABLED | "enabled" | +| ENABLED_BY_DEFAULT | "enabled_by_default" | +| FORCED | "forced" | + + + diff --git a/sdks/java-v2/docs/TemplateApi.md b/sdks/java-v2/docs/TemplateApi.md index ad8f86a70..1ba2b4773 100644 --- a/sdks/java-v2/docs/TemplateApi.md +++ b/sdks/java-v2/docs/TemplateApi.md @@ -145,6 +145,9 @@ public class TemplateCreateExample var fieldOptions = new SubFieldOptions(); fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var signerRoles1 = new SubTemplateRole(); signerRoles1.name("Client"); signerRoles1.order(0); @@ -217,6 +220,7 @@ public class TemplateCreateExample new File("./example_signature_request.pdf") )); templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerExperience(signerExperience); templateCreateRequest.signerRoles(signerRoles); templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); templateCreateRequest.mergeFields(mergeFields); @@ -1024,6 +1028,9 @@ public class TemplateUpdateExample ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); // ((HttpBearerAuth) config.getAuthentication("oauth2")).setBearerToken("YOUR_ACCESS_TOKEN"); + var signerExperience = new SubSignerExperience(); + signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); + var formFields1 = new SubUpdateFormField(); formFields1.apiId("uniqueIdHere_1"); formFields1.name("New name 1"); @@ -1038,7 +1045,6 @@ public class TemplateUpdateExample )); var templateUpdateRequest = new TemplateUpdateRequest(); - templateUpdateRequest.allowFormView(false); templateUpdateRequest.title("Test Title"); templateUpdateRequest.subject("Test Subject"); templateUpdateRequest.message("Test Message"); @@ -1046,6 +1052,7 @@ public class TemplateUpdateExample "CC Role 1", "CC Role 2" )); + templateUpdateRequest.signerExperience(signerExperience); templateUpdateRequest.formFields(formFields); try diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md index 40b9e6ca6..52f02f9a2 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md @@ -13,7 +13,6 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -34,6 +33,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/TemplateCreateRequest.md b/sdks/java-v2/docs/TemplateCreateRequest.md index 49525aa4c..895f63610 100644 --- a/sdks/java-v2/docs/TemplateCreateRequest.md +++ b/sdks/java-v2/docs/TemplateCreateRequest.md @@ -13,7 +13,6 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request | | | `clientId` | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | @@ -27,6 +26,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponse.md b/sdks/java-v2/docs/TemplateResponse.md index 9eaa7438e..32858edee 100644 --- a/sdks/java-v2/docs/TemplateResponse.md +++ b/sdks/java-v2/docs/TemplateResponse.md @@ -24,7 +24,7 @@ Contains information about the templates you and your team have created. | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments` | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/TemplateUpdateRequest.md b/sdks/java-v2/docs/TemplateUpdateRequest.md index 56d80eced..2162ed433 100644 --- a/sdks/java-v2/docs/TemplateUpdateRequest.md +++ b/sdks/java-v2/docs/TemplateUpdateRequest.md @@ -9,11 +9,11 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request. | | -| `allowFormView` | ```Boolean``` | The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `subject` | ```String``` | The new default template email subject. | | | `message` | ```String``` | The new default template email message. | | | `formFields` | [```List```](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md index b8d496953..aab362d77 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -14,7 +14,6 @@ | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md index 852847b61..b761f4b2f 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md @@ -12,7 +12,6 @@ | `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | -| `allowFormView` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | | `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | | `clientId` | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | @@ -33,6 +32,7 @@ | `usePreexistingFields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `useTextTags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java index 2e360bc7f..de0520124 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java @@ -20,6 +20,7 @@ import com.dropbox.sign.model.SignatureRequestResponseCustomFieldBase; import com.dropbox.sign.model.SignatureRequestResponseDataBase; import com.dropbox.sign.model.SignatureRequestResponseSignatures; +import com.dropbox.sign.model.SignatureRequestSignerExperience; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonCreator; @@ -65,7 +66,8 @@ BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_ATTACHMENTS, BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_RESPONSE_DATA, BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_SIGNATURES, - BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_BULK_SEND_JOB_ID + BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_BULK_SEND_JOB_ID, + BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -170,6 +172,10 @@ public class BulkSendJobGetResponseSignatureRequests { @jakarta.annotation.Nullable private String bulkSendJobId; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SignatureRequestSignerExperience signerExperience; + public BulkSendJobGetResponseSignatureRequests() { } @@ -869,6 +875,31 @@ public void setBulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) } + public BulkSendJobGetResponseSignatureRequests signerExperience(@jakarta.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SignatureRequestSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this BulkSendJobGetResponseSignatureRequests object is equal to o. */ @@ -905,12 +936,13 @@ public boolean equals(Object o) { Objects.equals(this.attachments, bulkSendJobGetResponseSignatureRequests.attachments) && Objects.equals(this.responseData, bulkSendJobGetResponseSignatureRequests.responseData) && Objects.equals(this.signatures, bulkSendJobGetResponseSignatureRequests.signatures) && - Objects.equals(this.bulkSendJobId, bulkSendJobGetResponseSignatureRequests.bulkSendJobId); + Objects.equals(this.bulkSendJobId, bulkSendJobGetResponseSignatureRequests.bulkSendJobId) && + Objects.equals(this.signerExperience, bulkSendJobGetResponseSignatureRequests.signerExperience); } @Override public int hashCode() { - return Objects.hash(testMode, signatureRequestId, requesterEmailAddress, title, originalTitle, subject, message, metadata, createdAt, expiresAt, isComplete, isDeclined, hasError, filesUrl, signingUrl, detailsUrl, ccEmailAddresses, signingRedirectUrl, finalCopyUri, templateIds, customFields, attachments, responseData, signatures, bulkSendJobId); + return Objects.hash(testMode, signatureRequestId, requesterEmailAddress, title, originalTitle, subject, message, metadata, createdAt, expiresAt, isComplete, isDeclined, hasError, filesUrl, signingUrl, detailsUrl, ccEmailAddresses, signingRedirectUrl, finalCopyUri, templateIds, customFields, attachments, responseData, signatures, bulkSendJobId, signerExperience); } @Override @@ -942,6 +974,7 @@ public String toString() { sb.append(" responseData: ").append(toIndentedString(responseData)).append("\n"); sb.append(" signatures: ").append(toIndentedString(signatures)).append("\n"); sb.append(" bulkSendJobId: ").append(toIndentedString(bulkSendJobId)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1425,6 +1458,25 @@ public Map createFormData() throws ApiException { map.put("bulk_send_job_id", JSON.getDefault().getMapper().writeValueAsString(bulkSendJobId)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java index f5d961b6e..6515bea9c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java @@ -18,6 +18,7 @@ import java.util.HashMap; import com.dropbox.sign.model.SubEditorOptions; import com.dropbox.sign.model.SubMergeField; +import com.dropbox.sign.model.SubSignerExperience; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonCreator; @@ -38,7 +39,6 @@ */ @JsonPropertyOrder({ EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_EDIT_CCS, - EmbeddedEditUrlRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, EmbeddedEditUrlRequest.JSON_PROPERTY_CC_ROLES, EmbeddedEditUrlRequest.JSON_PROPERTY_EDITOR_OPTIONS, EmbeddedEditUrlRequest.JSON_PROPERTY_FORCE_SIGNER_ROLES, @@ -47,7 +47,8 @@ EmbeddedEditUrlRequest.JSON_PROPERTY_PREVIEW_ONLY, EmbeddedEditUrlRequest.JSON_PROPERTY_SHOW_PREVIEW, EmbeddedEditUrlRequest.JSON_PROPERTY_SHOW_PROGRESS_STEPPER, - EmbeddedEditUrlRequest.JSON_PROPERTY_TEST_MODE + EmbeddedEditUrlRequest.JSON_PROPERTY_TEST_MODE, + EmbeddedEditUrlRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -56,10 +57,6 @@ public class EmbeddedEditUrlRequest { @jakarta.annotation.Nullable private Boolean allowEditCcs = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; @jakarta.annotation.Nullable private List ccRoles = null; @@ -96,6 +93,10 @@ public class EmbeddedEditUrlRequest { @jakarta.annotation.Nullable private Boolean testMode = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public EmbeddedEditUrlRequest() { } @@ -139,31 +140,6 @@ public void setAllowEditCcs(@jakarta.annotation.Nullable Boolean allowEditCcs) { } - public EmbeddedEditUrlRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public EmbeddedEditUrlRequest ccRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; @@ -405,6 +381,31 @@ public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { } + public EmbeddedEditUrlRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this EmbeddedEditUrlRequest object is equal to o. */ @@ -418,7 +419,6 @@ public boolean equals(Object o) { } EmbeddedEditUrlRequest embeddedEditUrlRequest = (EmbeddedEditUrlRequest) o; return Objects.equals(this.allowEditCcs, embeddedEditUrlRequest.allowEditCcs) && - Objects.equals(this.allowFormView, embeddedEditUrlRequest.allowFormView) && Objects.equals(this.ccRoles, embeddedEditUrlRequest.ccRoles) && Objects.equals(this.editorOptions, embeddedEditUrlRequest.editorOptions) && Objects.equals(this.forceSignerRoles, embeddedEditUrlRequest.forceSignerRoles) && @@ -427,12 +427,13 @@ public boolean equals(Object o) { Objects.equals(this.previewOnly, embeddedEditUrlRequest.previewOnly) && Objects.equals(this.showPreview, embeddedEditUrlRequest.showPreview) && Objects.equals(this.showProgressStepper, embeddedEditUrlRequest.showProgressStepper) && - Objects.equals(this.testMode, embeddedEditUrlRequest.testMode); + Objects.equals(this.testMode, embeddedEditUrlRequest.testMode) && + Objects.equals(this.signerExperience, embeddedEditUrlRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(allowEditCcs, allowFormView, ccRoles, editorOptions, forceSignerRoles, forceSubjectMessage, mergeFields, previewOnly, showPreview, showProgressStepper, testMode); + return Objects.hash(allowEditCcs, ccRoles, editorOptions, forceSignerRoles, forceSubjectMessage, mergeFields, previewOnly, showPreview, showProgressStepper, testMode, signerExperience); } @Override @@ -440,7 +441,6 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class EmbeddedEditUrlRequest {\n"); sb.append(" allowEditCcs: ").append(toIndentedString(allowEditCcs)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); sb.append(" forceSignerRoles: ").append(toIndentedString(forceSignerRoles)).append("\n"); @@ -450,6 +450,7 @@ public String toString() { sb.append(" showPreview: ").append(toIndentedString(showPreview)).append("\n"); sb.append(" showProgressStepper: ").append(toIndentedString(showProgressStepper)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -477,25 +478,6 @@ public Map createFormData() throws ApiException { map.put("allow_edit_ccs", JSON.getDefault().getMapper().writeValueAsString(allowEditCcs)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (ccRoles != null) { if (isFileTypeOrListOfFiles(ccRoles)) { fileTypeFound = true; @@ -667,6 +649,25 @@ public Map createFormData() throws ApiException { map.put("test_mode", JSON.getDefault().getMapper().writeValueAsString(testMode)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 0bee462ff..38232dfa1 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java @@ -24,6 +24,7 @@ import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -53,7 +54,6 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, - SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -71,6 +71,7 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_SIGNER_EXPERIENCE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @@ -100,10 +101,6 @@ public class SignatureRequestCreateEmbeddedRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -172,6 +169,10 @@ public class SignatureRequestCreateEmbeddedRequest { @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @jakarta.annotation.Nullable private Integer expiresAt; @@ -376,31 +377,6 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } - public SignatureRequestCreateEmbeddedRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public SignatureRequestCreateEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -882,6 +858,31 @@ public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean popul } + public SignatureRequestCreateEmbeddedRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + public SignatureRequestCreateEmbeddedRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; @@ -925,7 +926,6 @@ public boolean equals(Object o) { Objects.equals(this.signers, signatureRequestCreateEmbeddedRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestCreateEmbeddedRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestCreateEmbeddedRequest.allowDecline) && - Objects.equals(this.allowFormView, signatureRequestCreateEmbeddedRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestCreateEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestCreateEmbeddedRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestCreateEmbeddedRequest.ccEmailAddresses) && @@ -943,12 +943,13 @@ public boolean equals(Object o) { Objects.equals(this.title, signatureRequestCreateEmbeddedRequest.title) && Objects.equals(this.useTextTags, signatureRequestCreateEmbeddedRequest.useTextTags) && Objects.equals(this.populateAutoFillFields, signatureRequestCreateEmbeddedRequest.populateAutoFillFields) && + Objects.equals(this.signerExperience, signatureRequestCreateEmbeddedRequest.signerExperience) && Objects.equals(this.expiresAt, signatureRequestCreateEmbeddedRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, signerExperience, expiresAt); } @Override @@ -961,7 +962,6 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -979,6 +979,7 @@ public String toString() { sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1102,25 +1103,6 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; @@ -1444,6 +1426,25 @@ public Map createFormData() throws ApiException { map.put("populate_auto_fill_fields", JSON.getDefault().getMapper().writeValueAsString(populateAutoFillFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java index 6dc29fb8e..9a0383718 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java @@ -19,6 +19,7 @@ import com.dropbox.sign.model.SubCC; import com.dropbox.sign.model.SubCustomField; import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -56,7 +57,8 @@ SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, - SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS + SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -121,6 +123,10 @@ public class SignatureRequestCreateEmbeddedWithTemplateRequest { @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public SignatureRequestCreateEmbeddedWithTemplateRequest() { } @@ -570,6 +576,31 @@ public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean popul } + public SignatureRequestCreateEmbeddedWithTemplateRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestCreateEmbeddedWithTemplateRequest object is equal to o. */ @@ -596,12 +627,13 @@ public boolean equals(Object o) { Objects.equals(this.subject, signatureRequestCreateEmbeddedWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestCreateEmbeddedWithTemplateRequest.testMode) && Objects.equals(this.title, signatureRequestCreateEmbeddedWithTemplateRequest.title) && - Objects.equals(this.populateAutoFillFields, signatureRequestCreateEmbeddedWithTemplateRequest.populateAutoFillFields); + Objects.equals(this.populateAutoFillFields, signatureRequestCreateEmbeddedWithTemplateRequest.populateAutoFillFields) && + Objects.equals(this.signerExperience, signatureRequestCreateEmbeddedWithTemplateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields); + return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields, signerExperience); } @Override @@ -623,6 +655,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -916,6 +949,25 @@ public Map createFormData() throws ApiException { map.put("populate_auto_fill_fields", JSON.getDefault().getMapper().writeValueAsString(populateAutoFillFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index eba905c04..977354e9b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -24,6 +24,7 @@ import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -53,7 +54,6 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, - SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -71,7 +71,8 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, - SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -100,10 +101,6 @@ public class SignatureRequestEditEmbeddedRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -176,6 +173,10 @@ public class SignatureRequestEditEmbeddedRequest { @jakarta.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public SignatureRequestEditEmbeddedRequest() { } @@ -376,31 +377,6 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } - public SignatureRequestEditEmbeddedRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public SignatureRequestEditEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -907,6 +883,31 @@ public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { } + public SignatureRequestEditEmbeddedRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestEditEmbeddedRequest object is equal to o. */ @@ -925,7 +926,6 @@ public boolean equals(Object o) { Objects.equals(this.signers, signatureRequestEditEmbeddedRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestEditEmbeddedRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestEditEmbeddedRequest.allowDecline) && - Objects.equals(this.allowFormView, signatureRequestEditEmbeddedRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestEditEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditEmbeddedRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestEditEmbeddedRequest.ccEmailAddresses) && @@ -943,12 +943,13 @@ public boolean equals(Object o) { Objects.equals(this.title, signatureRequestEditEmbeddedRequest.title) && Objects.equals(this.useTextTags, signatureRequestEditEmbeddedRequest.useTextTags) && Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedRequest.populateAutoFillFields) && - Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt); + Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt) && + Objects.equals(this.signerExperience, signatureRequestEditEmbeddedRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt, signerExperience); } @Override @@ -961,7 +962,6 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -980,6 +980,7 @@ public String toString() { sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1102,25 +1103,6 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; @@ -1463,6 +1445,25 @@ public Map createFormData() throws ApiException { map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java index af702922f..2ec6b8e0b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java @@ -19,6 +19,7 @@ import com.dropbox.sign.model.SubCC; import com.dropbox.sign.model.SubCustomField; import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -56,7 +57,8 @@ SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, - SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -121,6 +123,10 @@ public class SignatureRequestEditEmbeddedWithTemplateRequest { @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public SignatureRequestEditEmbeddedWithTemplateRequest() { } @@ -570,6 +576,31 @@ public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean popul } + public SignatureRequestEditEmbeddedWithTemplateRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestEditEmbeddedWithTemplateRequest object is equal to o. */ @@ -596,12 +627,13 @@ public boolean equals(Object o) { Objects.equals(this.subject, signatureRequestEditEmbeddedWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestEditEmbeddedWithTemplateRequest.testMode) && Objects.equals(this.title, signatureRequestEditEmbeddedWithTemplateRequest.title) && - Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedWithTemplateRequest.populateAutoFillFields); + Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedWithTemplateRequest.populateAutoFillFields) && + Objects.equals(this.signerExperience, signatureRequestEditEmbeddedWithTemplateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields); + return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields, signerExperience); } @Override @@ -623,6 +655,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -916,6 +949,25 @@ public Map createFormData() throws ApiException { map.put("populate_auto_fill_fields", JSON.getDefault().getMapper().writeValueAsString(populateAutoFillFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 9a48397ba..e79784b8a 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -24,6 +24,7 @@ import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -52,7 +53,6 @@ SignatureRequestEditRequest.JSON_PROPERTY_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_DECLINE, - SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_REASSIGN, SignatureRequestEditRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestEditRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -72,7 +72,8 @@ SignatureRequestEditRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditRequest.JSON_PROPERTY_TITLE, SignatureRequestEditRequest.JSON_PROPERTY_USE_TEXT_TAGS, - SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT + SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -97,10 +98,6 @@ public class SignatureRequestEditRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -181,6 +178,10 @@ public class SignatureRequestEditRequest { @jakarta.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public SignatureRequestEditRequest() { } @@ -356,31 +357,6 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } - public SignatureRequestEditRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public SignatureRequestEditRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -937,6 +913,31 @@ public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { } + public SignatureRequestEditRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestEditRequest object is equal to o. */ @@ -954,7 +955,6 @@ public boolean equals(Object o) { Objects.equals(this.signers, signatureRequestEditRequest.signers) && Objects.equals(this.groupedSigners, signatureRequestEditRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestEditRequest.allowDecline) && - Objects.equals(this.allowFormView, signatureRequestEditRequest.allowFormView) && Objects.equals(this.allowReassign, signatureRequestEditRequest.allowReassign) && Objects.equals(this.attachments, signatureRequestEditRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestEditRequest.ccEmailAddresses) && @@ -974,12 +974,13 @@ public boolean equals(Object o) { Objects.equals(this.testMode, signatureRequestEditRequest.testMode) && Objects.equals(this.title, signatureRequestEditRequest.title) && Objects.equals(this.useTextTags, signatureRequestEditRequest.useTextTags) && - Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt); + Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt) && + Objects.equals(this.signerExperience, signatureRequestEditRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt, signerExperience); } @Override @@ -991,7 +992,6 @@ public String toString() { sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1012,6 +1012,7 @@ public String toString() { sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1115,25 +1116,6 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; @@ -1514,6 +1496,25 @@ public Map createFormData() throws ApiException { map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java index 02f2a4d2f..75a5d73c9 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java @@ -19,6 +19,7 @@ import com.dropbox.sign.model.SubCC; import com.dropbox.sign.model.SubCustomField; import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -57,7 +58,8 @@ SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -126,6 +128,10 @@ public class SignatureRequestEditWithTemplateRequest { @jakarta.annotation.Nullable private String title; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public SignatureRequestEditWithTemplateRequest() { } @@ -600,6 +606,31 @@ public void setTitle(@jakarta.annotation.Nullable String title) { } + public SignatureRequestEditWithTemplateRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestEditWithTemplateRequest object is equal to o. */ @@ -627,12 +658,13 @@ public boolean equals(Object o) { Objects.equals(this.signingRedirectUrl, signatureRequestEditWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestEditWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestEditWithTemplateRequest.testMode) && - Objects.equals(this.title, signatureRequestEditWithTemplateRequest.title); + Objects.equals(this.title, signatureRequestEditWithTemplateRequest.title) && + Objects.equals(this.signerExperience, signatureRequestEditWithTemplateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title); + return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, signerExperience); } @Override @@ -655,6 +687,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -967,6 +1000,25 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java index 481b8bd6b..dd7a6c960 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java @@ -20,6 +20,7 @@ import com.dropbox.sign.model.SignatureRequestResponseCustomFieldBase; import com.dropbox.sign.model.SignatureRequestResponseDataBase; import com.dropbox.sign.model.SignatureRequestResponseSignatures; +import com.dropbox.sign.model.SignatureRequestSignerExperience; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonCreator; @@ -65,7 +66,8 @@ SignatureRequestResponse.JSON_PROPERTY_ATTACHMENTS, SignatureRequestResponse.JSON_PROPERTY_RESPONSE_DATA, SignatureRequestResponse.JSON_PROPERTY_SIGNATURES, - SignatureRequestResponse.JSON_PROPERTY_BULK_SEND_JOB_ID + SignatureRequestResponse.JSON_PROPERTY_BULK_SEND_JOB_ID, + SignatureRequestResponse.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -170,6 +172,10 @@ public class SignatureRequestResponse { @jakarta.annotation.Nullable private String bulkSendJobId; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SignatureRequestSignerExperience signerExperience; + public SignatureRequestResponse() { } @@ -869,6 +875,31 @@ public void setBulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) } + public SignatureRequestResponse signerExperience(@jakarta.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SignatureRequestSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SignatureRequestSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestResponse object is equal to o. */ @@ -905,12 +936,13 @@ public boolean equals(Object o) { Objects.equals(this.attachments, signatureRequestResponse.attachments) && Objects.equals(this.responseData, signatureRequestResponse.responseData) && Objects.equals(this.signatures, signatureRequestResponse.signatures) && - Objects.equals(this.bulkSendJobId, signatureRequestResponse.bulkSendJobId); + Objects.equals(this.bulkSendJobId, signatureRequestResponse.bulkSendJobId) && + Objects.equals(this.signerExperience, signatureRequestResponse.signerExperience); } @Override public int hashCode() { - return Objects.hash(testMode, signatureRequestId, requesterEmailAddress, title, originalTitle, subject, message, metadata, createdAt, expiresAt, isComplete, isDeclined, hasError, filesUrl, signingUrl, detailsUrl, ccEmailAddresses, signingRedirectUrl, finalCopyUri, templateIds, customFields, attachments, responseData, signatures, bulkSendJobId); + return Objects.hash(testMode, signatureRequestId, requesterEmailAddress, title, originalTitle, subject, message, metadata, createdAt, expiresAt, isComplete, isDeclined, hasError, filesUrl, signingUrl, detailsUrl, ccEmailAddresses, signingRedirectUrl, finalCopyUri, templateIds, customFields, attachments, responseData, signatures, bulkSendJobId, signerExperience); } @Override @@ -942,6 +974,7 @@ public String toString() { sb.append(" responseData: ").append(toIndentedString(responseData)).append("\n"); sb.append(" signatures: ").append(toIndentedString(signatures)).append("\n"); sb.append(" bulkSendJobId: ").append(toIndentedString(bulkSendJobId)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1425,6 +1458,25 @@ public Map createFormData() throws ApiException { map.put("bulk_send_job_id", JSON.getDefault().getMapper().writeValueAsString(bulkSendJobId)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index 68364f8cc..cf7c899e7 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -24,6 +24,7 @@ import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -53,7 +54,6 @@ SignatureRequestSendRequest.JSON_PROPERTY_GROUPED_SIGNERS, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_DECLINE, SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_REASSIGN, - SignatureRequestSendRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, SignatureRequestSendRequest.JSON_PROPERTY_ATTACHMENTS, SignatureRequestSendRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, SignatureRequestSendRequest.JSON_PROPERTY_CLIENT_ID, @@ -73,7 +73,8 @@ SignatureRequestSendRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestSendRequest.JSON_PROPERTY_TITLE, SignatureRequestSendRequest.JSON_PROPERTY_USE_TEXT_TAGS, - SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT + SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT, + SignatureRequestSendRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -102,10 +103,6 @@ public class SignatureRequestSendRequest { @jakarta.annotation.Nullable private Boolean allowReassign = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -187,6 +184,10 @@ public class SignatureRequestSendRequest { @jakarta.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public SignatureRequestSendRequest() { } @@ -387,31 +388,6 @@ public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) } - public SignatureRequestSendRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public SignatureRequestSendRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -972,6 +948,31 @@ public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { } + public SignatureRequestSendRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestSendRequest object is equal to o. */ @@ -990,7 +991,6 @@ public boolean equals(Object o) { Objects.equals(this.groupedSigners, signatureRequestSendRequest.groupedSigners) && Objects.equals(this.allowDecline, signatureRequestSendRequest.allowDecline) && Objects.equals(this.allowReassign, signatureRequestSendRequest.allowReassign) && - Objects.equals(this.allowFormView, signatureRequestSendRequest.allowFormView) && Objects.equals(this.attachments, signatureRequestSendRequest.attachments) && Objects.equals(this.ccEmailAddresses, signatureRequestSendRequest.ccEmailAddresses) && Objects.equals(this.clientId, signatureRequestSendRequest.clientId) && @@ -1010,12 +1010,13 @@ public boolean equals(Object o) { Objects.equals(this.testMode, signatureRequestSendRequest.testMode) && Objects.equals(this.title, signatureRequestSendRequest.title) && Objects.equals(this.useTextTags, signatureRequestSendRequest.useTextTags) && - Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt); + Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt) && + Objects.equals(this.signerExperience, signatureRequestSendRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, allowFormView, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt, signerExperience); } @Override @@ -1028,7 +1029,6 @@ public String toString() { sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1049,6 +1049,7 @@ public String toString() { sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1171,25 +1172,6 @@ public Map createFormData() throws ApiException { map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1570,6 +1552,25 @@ public Map createFormData() throws ApiException { map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java index 861f52e96..aa5ec783f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java @@ -19,6 +19,7 @@ import com.dropbox.sign.model.SubCC; import com.dropbox.sign.model.SubCustomField; import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -58,7 +59,8 @@ SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SUBJECT, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TEST_MODE, - SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -132,6 +134,10 @@ public class SignatureRequestSendWithTemplateRequest { @jakarta.annotation.Nullable private String title; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public SignatureRequestSendWithTemplateRequest() { } @@ -635,6 +641,31 @@ public void setTitle(@jakarta.annotation.Nullable String title) { } + public SignatureRequestSendWithTemplateRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this SignatureRequestSendWithTemplateRequest object is equal to o. */ @@ -663,12 +694,13 @@ public boolean equals(Object o) { Objects.equals(this.signingRedirectUrl, signatureRequestSendWithTemplateRequest.signingRedirectUrl) && Objects.equals(this.subject, signatureRequestSendWithTemplateRequest.subject) && Objects.equals(this.testMode, signatureRequestSendWithTemplateRequest.testMode) && - Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title); + Objects.equals(this.title, signatureRequestSendWithTemplateRequest.title) && + Objects.equals(this.signerExperience, signatureRequestSendWithTemplateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title); + return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, signerExperience); } @Override @@ -692,6 +724,7 @@ public String toString() { sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1023,6 +1056,25 @@ public Map createFormData() throws ApiException { map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSignerExperience.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSignerExperience.java new file mode 100644 index 000000000..dd25537cf --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSignerExperience.java @@ -0,0 +1,218 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + */ +@JsonPropertyOrder({ + SignatureRequestSignerExperience.JSON_PROPERTY_FORM_VIEW +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestSignerExperience { + /** + * Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + */ + public enum FormViewEnum { + DISABLED(String.valueOf("disabled")), + + ENABLED(String.valueOf("enabled")), + + ENABLED_BY_DEFAULT(String.valueOf("enabled_by_default")), + + FORCED(String.valueOf("forced")); + + private String value; + + FormViewEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FormViewEnum fromValue(String value) { + for (FormViewEnum b : FormViewEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FORM_VIEW = "form_view"; + @jakarta.annotation.Nonnull + private FormViewEnum formView; + + public SignatureRequestSignerExperience() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestSignerExperience init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestSignerExperience.class); + } + + static public SignatureRequestSignerExperience init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestSignerExperience.class + ); + } + + public SignatureRequestSignerExperience formView(@jakarta.annotation.Nonnull FormViewEnum formView) { + this.formView = formView; + return this; + } + + /** + * Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + * @return formView + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public FormViewEnum getFormView() { + return formView; + } + + + @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setFormView(@jakarta.annotation.Nonnull FormViewEnum formView) { + this.formView = formView; + } + + + /** + * Return true if this SignatureRequestSignerExperience object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestSignerExperience signatureRequestSignerExperience = (SignatureRequestSignerExperience) o; + return Objects.equals(this.formView, signatureRequestSignerExperience.formView); + } + + @Override + public int hashCode() { + return Objects.hash(formView); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestSignerExperience {\n"); + sb.append(" formView: ").append(toIndentedString(formView)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (formView != null) { + if (isFileTypeOrListOfFiles(formView)) { + fileTypeFound = true; + } + + if (formView.getClass().equals(java.io.File.class) || + formView.getClass().equals(Integer.class) || + formView.getClass().equals(String.class) || + formView.getClass().isEnum()) { + map.put("form_view", formView); + } else if (isListOfFile(formView)) { + for(int i = 0; i< getListSize(formView); i++) { + map.put("form_view[" + i + "]", getFromList(formView, i)); + } + } + else { + map.put("form_view", JSON.getDefault().getMapper().writeValueAsString(formView)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignerExperience.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignerExperience.java new file mode 100644 index 000000000..a1d53b549 --- /dev/null +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSignerExperience.java @@ -0,0 +1,218 @@ +/* + * Dropbox Sign API + * Dropbox Sign v3 API + * + * The version of the OpenAPI document: 3.0.0 + * Contact: apisupport@hellosign.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.dropbox.sign.model; + +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.Arrays; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.dropbox.sign.JSON; +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; + + +import com.dropbox.sign.ApiException; +/** + * Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + */ +@JsonPropertyOrder({ + SubSignerExperience.JSON_PROPERTY_FORM_VIEW +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SubSignerExperience { + /** + * Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + */ + public enum FormViewEnum { + DISABLED(String.valueOf("disabled")), + + ENABLED(String.valueOf("enabled")), + + ENABLED_BY_DEFAULT(String.valueOf("enabled_by_default")), + + FORCED(String.valueOf("forced")); + + private String value; + + FormViewEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FormViewEnum fromValue(String value) { + for (FormViewEnum b : FormViewEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FORM_VIEW = "form_view"; + @jakarta.annotation.Nullable + private FormViewEnum formView; + + public SubSignerExperience() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SubSignerExperience init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SubSignerExperience.class); + } + + static public SubSignerExperience init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SubSignerExperience.class + ); + } + + public SubSignerExperience formView(@jakarta.annotation.Nullable FormViewEnum formView) { + this.formView = formView; + return this; + } + + /** + * Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + * @return formView + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FormViewEnum getFormView() { + return formView; + } + + + @JsonProperty(JSON_PROPERTY_FORM_VIEW) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormView(@jakarta.annotation.Nullable FormViewEnum formView) { + this.formView = formView; + } + + + /** + * Return true if this SubSignerExperience object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SubSignerExperience subSignerExperience = (SubSignerExperience) o; + return Objects.equals(this.formView, subSignerExperience.formView); + } + + @Override + public int hashCode() { + return Objects.hash(formView); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SubSignerExperience {\n"); + sb.append(" formView: ").append(toIndentedString(formView)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (formView != null) { + if (isFileTypeOrListOfFiles(formView)) { + fileTypeFound = true; + } + + if (formView.getClass().equals(java.io.File.class) || + formView.getClass().equals(Integer.class) || + formView.getClass().equals(String.class) || + formView.getClass().isEnum()) { + map.put("form_view", formView); + } else if (isListOfFile(formView)) { + for(int i = 0; i< getListSize(formView); i++) { + map.put("form_view[" + i + "]", getFromList(formView, i)); + } + } + else { + map.put("form_view", JSON.getDefault().getMapper().writeValueAsString(formView)); + } + } + } catch (Exception e) { + throw new ApiException(e); + } + + return fileTypeFound ? map : new HashMap<>(); + } + + private boolean isFileTypeOrListOfFiles(Object obj) throws Exception { + return obj.getClass().equals(java.io.File.class) || isListOfFile(obj); + } + + private boolean isListOfFile(Object obj) throws Exception { + return obj instanceof java.util.List && !isListEmpty(obj) && getFromList(obj, 0) instanceof java.io.File; + } + + private boolean isListEmpty(Object obj) throws Exception { + return (boolean) Class.forName(java.util.List.class.getName()).getMethod("isEmpty").invoke(obj); + } + + private Object getFromList(Object obj, int index) throws Exception { + return Class.forName(java.util.List.class.getName()).getMethod("get", int.class).invoke(obj, index); + } + + private int getListSize(Object obj) throws Exception { + return (int) Class.forName(java.util.List.class.getName()).getMethod("size").invoke(obj); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index 943d6c684..a42daea90 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java @@ -23,6 +23,7 @@ import com.dropbox.sign.model.SubFormFieldRule; import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; import com.dropbox.sign.model.SubMergeField; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubTemplateRole; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -51,7 +52,6 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_CCS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_REASSIGN, - TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_EDITOR_OPTIONS, @@ -71,7 +71,8 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_SUBJECT, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TITLE, - TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -96,10 +97,6 @@ public class TemplateCreateEmbeddedDraftRequest { @jakarta.annotation.Nullable private Boolean allowReassign = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -180,6 +177,10 @@ public class TemplateCreateEmbeddedDraftRequest { @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public TemplateCreateEmbeddedDraftRequest() { } @@ -339,31 +340,6 @@ public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) } - public TemplateCreateEmbeddedDraftRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public TemplateCreateEmbeddedDraftRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -928,6 +904,31 @@ public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePree } + public TemplateCreateEmbeddedDraftRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this TemplateCreateEmbeddedDraftRequest object is equal to o. */ @@ -945,7 +946,6 @@ public boolean equals(Object o) { Objects.equals(this.fileUrls, templateCreateEmbeddedDraftRequest.fileUrls) && Objects.equals(this.allowCcs, templateCreateEmbeddedDraftRequest.allowCcs) && Objects.equals(this.allowReassign, templateCreateEmbeddedDraftRequest.allowReassign) && - Objects.equals(this.allowFormView, templateCreateEmbeddedDraftRequest.allowFormView) && Objects.equals(this.attachments, templateCreateEmbeddedDraftRequest.attachments) && Objects.equals(this.ccRoles, templateCreateEmbeddedDraftRequest.ccRoles) && Objects.equals(this.editorOptions, templateCreateEmbeddedDraftRequest.editorOptions) && @@ -965,12 +965,13 @@ public boolean equals(Object o) { Objects.equals(this.subject, templateCreateEmbeddedDraftRequest.subject) && Objects.equals(this.testMode, templateCreateEmbeddedDraftRequest.testMode) && Objects.equals(this.title, templateCreateEmbeddedDraftRequest.title) && - Objects.equals(this.usePreexistingFields, templateCreateEmbeddedDraftRequest.usePreexistingFields); + Objects.equals(this.usePreexistingFields, templateCreateEmbeddedDraftRequest.usePreexistingFields) && + Objects.equals(this.signerExperience, templateCreateEmbeddedDraftRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, allowCcs, allowReassign, allowFormView, attachments, ccRoles, editorOptions, fieldOptions, forceSignerRoles, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, mergeFields, message, metadata, showPreview, showProgressStepper, signerRoles, skipMeNow, subject, testMode, title, usePreexistingFields); + return Objects.hash(clientId, files, fileUrls, allowCcs, allowReassign, attachments, ccRoles, editorOptions, fieldOptions, forceSignerRoles, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, mergeFields, message, metadata, showPreview, showProgressStepper, signerRoles, skipMeNow, subject, testMode, title, usePreexistingFields, signerExperience); } @Override @@ -982,7 +983,6 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" editorOptions: ").append(toIndentedString(editorOptions)).append("\n"); @@ -1003,6 +1003,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" usePreexistingFields: ").append(toIndentedString(usePreexistingFields)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1106,25 +1107,6 @@ public Map createFormData() throws ApiException { map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1505,6 +1487,25 @@ public Map createFormData() throws ApiException { map.put("use_preexisting_fields", JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index eeb04d082..4f4e8a036 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java @@ -22,6 +22,7 @@ import com.dropbox.sign.model.SubFormFieldRule; import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; import com.dropbox.sign.model.SubMergeField; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubTemplateRole; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -50,7 +51,6 @@ TemplateCreateRequest.JSON_PROPERTY_FILES, TemplateCreateRequest.JSON_PROPERTY_FILE_URLS, TemplateCreateRequest.JSON_PROPERTY_ALLOW_REASSIGN, - TemplateCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateCreateRequest.JSON_PROPERTY_ATTACHMENTS, TemplateCreateRequest.JSON_PROPERTY_CC_ROLES, TemplateCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -63,7 +63,8 @@ TemplateCreateRequest.JSON_PROPERTY_SUBJECT, TemplateCreateRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateRequest.JSON_PROPERTY_TITLE, - TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -88,10 +89,6 @@ public class TemplateCreateRequest { @jakarta.annotation.Nullable private Boolean allowReassign = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -144,6 +141,10 @@ public class TemplateCreateRequest { @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public TemplateCreateRequest() { } @@ -319,31 +320,6 @@ public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) } - public TemplateCreateRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public TemplateCreateRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -717,6 +693,31 @@ public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePree } + public TemplateCreateRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this TemplateCreateRequest object is equal to o. */ @@ -734,7 +735,6 @@ public boolean equals(Object o) { Objects.equals(this.files, templateCreateRequest.files) && Objects.equals(this.fileUrls, templateCreateRequest.fileUrls) && Objects.equals(this.allowReassign, templateCreateRequest.allowReassign) && - Objects.equals(this.allowFormView, templateCreateRequest.allowFormView) && Objects.equals(this.attachments, templateCreateRequest.attachments) && Objects.equals(this.ccRoles, templateCreateRequest.ccRoles) && Objects.equals(this.clientId, templateCreateRequest.clientId) && @@ -747,12 +747,13 @@ public boolean equals(Object o) { Objects.equals(this.subject, templateCreateRequest.subject) && Objects.equals(this.testMode, templateCreateRequest.testMode) && Objects.equals(this.title, templateCreateRequest.title) && - Objects.equals(this.usePreexistingFields, templateCreateRequest.usePreexistingFields); + Objects.equals(this.usePreexistingFields, templateCreateRequest.usePreexistingFields) && + Objects.equals(this.signerExperience, templateCreateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(formFieldsPerDocument, signerRoles, files, fileUrls, allowReassign, allowFormView, attachments, ccRoles, clientId, fieldOptions, formFieldGroups, formFieldRules, mergeFields, message, metadata, subject, testMode, title, usePreexistingFields); + return Objects.hash(formFieldsPerDocument, signerRoles, files, fileUrls, allowReassign, attachments, ccRoles, clientId, fieldOptions, formFieldGroups, formFieldRules, mergeFields, message, metadata, subject, testMode, title, usePreexistingFields, signerExperience); } @Override @@ -764,7 +765,6 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -778,6 +778,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" usePreexistingFields: ").append(toIndentedString(usePreexistingFields)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -881,25 +882,6 @@ public Map createFormData() throws ApiException { map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1147,6 +1129,25 @@ public Map createFormData() throws ApiException { map.put("use_preexisting_fields", JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java index a1291b3e8..462bc57ac 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -17,6 +17,7 @@ import java.util.Map; import java.util.HashMap; import com.dropbox.sign.model.SignatureRequestResponseAttachment; +import com.dropbox.sign.model.SignatureRequestSignerExperience; import com.dropbox.sign.model.TemplateResponseAccount; import com.dropbox.sign.model.TemplateResponseCCRole; import com.dropbox.sign.model.TemplateResponseDocument; @@ -60,7 +61,7 @@ TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, TemplateResponse.JSON_PROPERTY_ACCOUNTS, TemplateResponse.JSON_PROPERTY_ATTACHMENTS, - TemplateResponse.JSON_PROPERTY_ALLOW_FORM_VIEW + TemplateResponse.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -131,9 +132,9 @@ public class TemplateResponse { @jakarta.annotation.Nullable private List attachments = null; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; @jakarta.annotation.Nullable - private Boolean allowFormView; + private SignatureRequestSignerExperience signerExperience; public TemplateResponse() { } @@ -625,28 +626,28 @@ public void setAttachments(@jakarta.annotation.Nullable List createFormData() throws ApiException { map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { fileTypeFound = true; } - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); } } else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); } } } catch (Exception e) { diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java index 5b42e7eb7..26359f582 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateRequest.java @@ -16,6 +16,7 @@ import java.util.Objects; import java.util.Map; import java.util.HashMap; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubUpdateFormField; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -37,11 +38,11 @@ */ @JsonPropertyOrder({ TemplateUpdateRequest.JSON_PROPERTY_CC_ROLES, - TemplateUpdateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, TemplateUpdateRequest.JSON_PROPERTY_TITLE, TemplateUpdateRequest.JSON_PROPERTY_SUBJECT, TemplateUpdateRequest.JSON_PROPERTY_MESSAGE, - TemplateUpdateRequest.JSON_PROPERTY_FORM_FIELDS + TemplateUpdateRequest.JSON_PROPERTY_FORM_FIELDS, + TemplateUpdateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -50,10 +51,6 @@ public class TemplateUpdateRequest { @jakarta.annotation.Nullable private List ccRoles = null; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView; - public static final String JSON_PROPERTY_TITLE = "title"; @jakarta.annotation.Nullable private String title; @@ -70,6 +67,10 @@ public class TemplateUpdateRequest { @jakarta.annotation.Nullable private List formFields = null; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public TemplateUpdateRequest() { } @@ -121,31 +122,6 @@ public void setCcRoles(@jakarta.annotation.Nullable List ccRoles) { } - public TemplateUpdateRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public TemplateUpdateRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; @@ -254,6 +230,31 @@ public void setFormFields(@jakarta.annotation.Nullable List } + public TemplateUpdateRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this TemplateUpdateRequest object is equal to o. */ @@ -267,16 +268,16 @@ public boolean equals(Object o) { } TemplateUpdateRequest templateUpdateRequest = (TemplateUpdateRequest) o; return Objects.equals(this.ccRoles, templateUpdateRequest.ccRoles) && - Objects.equals(this.allowFormView, templateUpdateRequest.allowFormView) && Objects.equals(this.title, templateUpdateRequest.title) && Objects.equals(this.subject, templateUpdateRequest.subject) && Objects.equals(this.message, templateUpdateRequest.message) && - Objects.equals(this.formFields, templateUpdateRequest.formFields); + Objects.equals(this.formFields, templateUpdateRequest.formFields) && + Objects.equals(this.signerExperience, templateUpdateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(ccRoles, allowFormView, title, subject, message, formFields); + return Objects.hash(ccRoles, title, subject, message, formFields, signerExperience); } @Override @@ -284,11 +285,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateUpdateRequest {\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" subject: ").append(toIndentedString(subject)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -316,25 +317,6 @@ public Map createFormData() throws ApiException { map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (title != null) { if (isFileTypeOrListOfFiles(title)) { fileTypeFound = true; @@ -411,6 +393,25 @@ public Map createFormData() throws ApiException { map.put("form_fields", JSON.getDefault().getMapper().writeValueAsString(formFields)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 07817eb8c..0c762b684 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java @@ -53,7 +53,6 @@ UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_CCS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, - UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, @@ -112,10 +111,6 @@ public class UnclaimedDraftCreateEmbeddedRequest { @jakarta.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; @jakarta.annotation.Nullable private Boolean allowReassign = false; @@ -455,31 +450,6 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } - public UnclaimedDraftCreateEmbeddedRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public UnclaimedDraftCreateEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; @@ -1312,7 +1282,6 @@ public boolean equals(Object o) { Objects.equals(this.fileUrls, unclaimedDraftCreateEmbeddedRequest.fileUrls) && Objects.equals(this.allowCcs, unclaimedDraftCreateEmbeddedRequest.allowCcs) && Objects.equals(this.allowDecline, unclaimedDraftCreateEmbeddedRequest.allowDecline) && - Objects.equals(this.allowFormView, unclaimedDraftCreateEmbeddedRequest.allowFormView) && Objects.equals(this.allowReassign, unclaimedDraftCreateEmbeddedRequest.allowReassign) && Objects.equals(this.attachments, unclaimedDraftCreateEmbeddedRequest.attachments) && Objects.equals(this.ccEmailAddresses, unclaimedDraftCreateEmbeddedRequest.ccEmailAddresses) && @@ -1347,7 +1316,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(clientId, requesterEmailAddress, files, fileUrls, allowCcs, allowDecline, allowFormView, allowReassign, attachments, ccEmailAddresses, customFields, editorOptions, fieldOptions, forceSignerPage, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, holdRequest, isForEmbeddedSigning, message, metadata, requestingRedirectUrl, showPreview, showProgressStepper, signers, signingOptions, signingRedirectUrl, skipMeNow, subject, testMode, type, usePreexistingFields, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, requesterEmailAddress, files, fileUrls, allowCcs, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, editorOptions, fieldOptions, forceSignerPage, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, holdRequest, isForEmbeddedSigning, message, metadata, requestingRedirectUrl, showPreview, showProgressStepper, signers, signingOptions, signingRedirectUrl, skipMeNow, subject, testMode, type, usePreexistingFields, useTextTags, populateAutoFillFields, expiresAt); } @Override @@ -1360,7 +1329,6 @@ public String toString() { sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowCcs: ").append(toIndentedString(allowCcs)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); @@ -1513,25 +1481,6 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (allowReassign != null) { if (isFileTypeOrListOfFiles(allowReassign)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 4c97368c0..d3accc865 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java @@ -22,6 +22,7 @@ import com.dropbox.sign.model.SubFormFieldGroup; import com.dropbox.sign.model.SubFormFieldRule; import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; +import com.dropbox.sign.model.SubSignerExperience; import com.dropbox.sign.model.SubSigningOptions; import com.dropbox.sign.model.SubUnclaimedDraftSigner; import com.fasterxml.jackson.annotation.JsonInclude; @@ -50,7 +51,6 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_FILES, UnclaimedDraftCreateRequest.JSON_PROPERTY_FILE_URLS, UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_DECLINE, - UnclaimedDraftCreateRequest.JSON_PROPERTY_ALLOW_FORM_VIEW, UnclaimedDraftCreateRequest.JSON_PROPERTY_ATTACHMENTS, UnclaimedDraftCreateRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, UnclaimedDraftCreateRequest.JSON_PROPERTY_CLIENT_ID, @@ -70,7 +70,8 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_TEST_MODE, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_TEXT_TAGS, - UnclaimedDraftCreateRequest.JSON_PROPERTY_EXPIRES_AT + UnclaimedDraftCreateRequest.JSON_PROPERTY_EXPIRES_AT, + UnclaimedDraftCreateRequest.JSON_PROPERTY_SIGNER_EXPERIENCE }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -126,10 +127,6 @@ public static TypeEnum fromValue(String value) { @jakarta.annotation.Nullable private Boolean allowDecline = false; - public static final String JSON_PROPERTY_ALLOW_FORM_VIEW = "allow_form_view"; - @jakarta.annotation.Nullable - private Boolean allowFormView = false; - public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; @jakarta.annotation.Nullable private List attachments = null; @@ -210,6 +207,10 @@ public static TypeEnum fromValue(String value) { @jakarta.annotation.Nullable private Integer expiresAt; + public static final String JSON_PROPERTY_SIGNER_EXPERIENCE = "signer_experience"; + @jakarta.annotation.Nullable + private SubSignerExperience signerExperience; + public UnclaimedDraftCreateRequest() { } @@ -344,31 +345,6 @@ public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { } - public UnclaimedDraftCreateRequest allowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - return this; - } - - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * @return allowFormView - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getAllowFormView() { - return allowFormView; - } - - - @JsonProperty(JSON_PROPERTY_ALLOW_FORM_VIEW) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowFormView(@jakarta.annotation.Nullable Boolean allowFormView) { - this.allowFormView = allowFormView; - } - - public UnclaimedDraftCreateRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; @@ -933,6 +909,31 @@ public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { } + public UnclaimedDraftCreateRequest signerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + return this; + } + + /** + * Get signerExperience + * @return signerExperience + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSignerExperience getSignerExperience() { + return signerExperience; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_EXPERIENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSignerExperience(@jakarta.annotation.Nullable SubSignerExperience signerExperience) { + this.signerExperience = signerExperience; + } + + /** * Return true if this UnclaimedDraftCreateRequest object is equal to o. */ @@ -949,7 +950,6 @@ public boolean equals(Object o) { Objects.equals(this.files, unclaimedDraftCreateRequest.files) && Objects.equals(this.fileUrls, unclaimedDraftCreateRequest.fileUrls) && Objects.equals(this.allowDecline, unclaimedDraftCreateRequest.allowDecline) && - Objects.equals(this.allowFormView, unclaimedDraftCreateRequest.allowFormView) && Objects.equals(this.attachments, unclaimedDraftCreateRequest.attachments) && Objects.equals(this.ccEmailAddresses, unclaimedDraftCreateRequest.ccEmailAddresses) && Objects.equals(this.clientId, unclaimedDraftCreateRequest.clientId) && @@ -969,12 +969,13 @@ public boolean equals(Object o) { Objects.equals(this.testMode, unclaimedDraftCreateRequest.testMode) && Objects.equals(this.usePreexistingFields, unclaimedDraftCreateRequest.usePreexistingFields) && Objects.equals(this.useTextTags, unclaimedDraftCreateRequest.useTextTags) && - Objects.equals(this.expiresAt, unclaimedDraftCreateRequest.expiresAt); + Objects.equals(this.expiresAt, unclaimedDraftCreateRequest.expiresAt) && + Objects.equals(this.signerExperience, unclaimedDraftCreateRequest.signerExperience); } @Override public int hashCode() { - return Objects.hash(type, files, fileUrls, allowDecline, allowFormView, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, showProgressStepper, signers, signingOptions, signingRedirectUrl, subject, testMode, usePreexistingFields, useTextTags, expiresAt); + return Objects.hash(type, files, fileUrls, allowDecline, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, showProgressStepper, signers, signingOptions, signingRedirectUrl, subject, testMode, usePreexistingFields, useTextTags, expiresAt, signerExperience); } @Override @@ -985,7 +986,6 @@ public String toString() { sb.append(" files: ").append(toIndentedString(files)).append("\n"); sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); - sb.append(" allowFormView: ").append(toIndentedString(allowFormView)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); @@ -1006,6 +1006,7 @@ public String toString() { sb.append(" usePreexistingFields: ").append(toIndentedString(usePreexistingFields)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append(" signerExperience: ").append(toIndentedString(signerExperience)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1090,25 +1091,6 @@ public Map createFormData() throws ApiException { map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); } } - if (allowFormView != null) { - if (isFileTypeOrListOfFiles(allowFormView)) { - fileTypeFound = true; - } - - if (allowFormView.getClass().equals(java.io.File.class) || - allowFormView.getClass().equals(Integer.class) || - allowFormView.getClass().equals(String.class) || - allowFormView.getClass().isEnum()) { - map.put("allow_form_view", allowFormView); - } else if (isListOfFile(allowFormView)) { - for(int i = 0; i< getListSize(allowFormView); i++) { - map.put("allow_form_view[" + i + "]", getFromList(allowFormView, i)); - } - } - else { - map.put("allow_form_view", JSON.getDefault().getMapper().writeValueAsString(allowFormView)); - } - } if (attachments != null) { if (isFileTypeOrListOfFiles(attachments)) { fileTypeFound = true; @@ -1489,6 +1471,25 @@ public Map createFormData() throws ApiException { map.put("expires_at", JSON.getDefault().getMapper().writeValueAsString(expiresAt)); } } + if (signerExperience != null) { + if (isFileTypeOrListOfFiles(signerExperience)) { + fileTypeFound = true; + } + + if (signerExperience.getClass().equals(java.io.File.class) || + signerExperience.getClass().equals(Integer.class) || + signerExperience.getClass().equals(String.class) || + signerExperience.getClass().isEnum()) { + map.put("signer_experience", signerExperience); + } else if (isListOfFile(signerExperience)) { + for(int i = 0; i< getListSize(signerExperience); i++) { + map.put("signer_experience[" + i + "]", getFromList(signerExperience, i)); + } + } + else { + map.put("signer_experience", JSON.getDefault().getMapper().writeValueAsString(signerExperience)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/node/README.md b/sdks/node/README.md index 19d311d6c..83a5f8d4a 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -247,6 +247,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SignatureRequestResponseSignatures](./docs/model/SignatureRequestResponseSignatures.md) - [SignatureRequestSendRequest](./docs/model/SignatureRequestSendRequest.md) - [SignatureRequestSendWithTemplateRequest](./docs/model/SignatureRequestSendWithTemplateRequest.md) +- [SignatureRequestSignerExperience](./docs/model/SignatureRequestSignerExperience.md) - [SignatureRequestUpdateRequest](./docs/model/SignatureRequestUpdateRequest.md) - [SubAttachment](./docs/model/SubAttachment.md) - [SubBulkSignerList](./docs/model/SubBulkSignerList.md) @@ -278,6 +279,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SubSignatureRequestGroupedSigners](./docs/model/SubSignatureRequestGroupedSigners.md) - [SubSignatureRequestSigner](./docs/model/SubSignatureRequestSigner.md) - [SubSignatureRequestTemplateSigner](./docs/model/SubSignatureRequestTemplateSigner.md) +- [SubSignerExperience](./docs/model/SubSignerExperience.md) - [SubSigningOptions](./docs/model/SubSigningOptions.md) - [SubTeamResponse](./docs/model/SubTeamResponse.md) - [SubTemplateRole](./docs/model/SubTemplateRole.md) diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 989d4e230..da8fc4b8e 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -13251,6 +13251,7 @@ __export(api_exports, { SignatureRequestResponseSignatures: () => SignatureRequestResponseSignatures, SignatureRequestSendRequest: () => SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest: () => SignatureRequestSendWithTemplateRequest, + SignatureRequestSignerExperience: () => SignatureRequestSignerExperience, SignatureRequestUpdateRequest: () => SignatureRequestUpdateRequest, SubAttachment: () => SubAttachment, SubBulkSignerList: () => SubBulkSignerList, @@ -13282,6 +13283,7 @@ __export(api_exports, { SubSignatureRequestGroupedSigners: () => SubSignatureRequestGroupedSigners, SubSignatureRequestSigner: () => SubSignatureRequestSigner, SubSignatureRequestTemplateSigner: () => SubSignatureRequestTemplateSigner, + SubSignerExperience: () => SubSignerExperience, SubSigningOptions: () => SubSigningOptions, SubTeamResponse: () => SubTeamResponse, SubTemplateRole: () => SubTemplateRole, @@ -17643,6 +17645,11 @@ var BulkSendJobGetResponseSignatureRequests = class _BulkSendJobGetResponseSigna name: "bulkSendJobId", baseName: "bulk_send_job_id", type: "string" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SignatureRequestSignerExperience" } ]; } @@ -17764,10 +17771,6 @@ var EmbeddedEditUrlRequest = class _EmbeddedEditUrlRequest { * This allows the requester to enable/disable to add or change CC roles when editing the template. */ this["allowEditCcs"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Provide users the ability to review/edit the template signer roles. */ @@ -17803,11 +17806,6 @@ var EmbeddedEditUrlRequest = class _EmbeddedEditUrlRequest { baseName: "allow_edit_ccs", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "ccRoles", baseName: "cc_roles", @@ -17852,6 +17850,11 @@ var EmbeddedEditUrlRequest = class _EmbeddedEditUrlRequest { name: "testMode", baseName: "test_mode", type: "boolean" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -19565,10 +19568,6 @@ var SignatureRequestCreateEmbeddedRequest = class _SignatureRequestCreateEmbedde * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ @@ -19625,11 +19624,6 @@ var SignatureRequestCreateEmbeddedRequest = class _SignatureRequestCreateEmbedde baseName: "allow_decline", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "allowReassign", baseName: "allow_reassign", @@ -19715,6 +19709,11 @@ var SignatureRequestCreateEmbeddedRequest = class _SignatureRequestCreateEmbedde baseName: "populate_auto_fill_fields", type: "boolean" }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" + }, { name: "expiresAt", baseName: "expires_at", @@ -19829,6 +19828,11 @@ var SignatureRequestCreateEmbeddedWithTemplateRequest = class _SignatureRequestC name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", type: "boolean" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -19851,10 +19855,6 @@ var SignatureRequestEditEmbeddedRequest = class _SignatureRequestEditEmbeddedReq * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ @@ -19911,11 +19911,6 @@ var SignatureRequestEditEmbeddedRequest = class _SignatureRequestEditEmbeddedReq baseName: "allow_decline", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "allowReassign", baseName: "allow_reassign", @@ -20005,6 +20000,11 @@ var SignatureRequestEditEmbeddedRequest = class _SignatureRequestEditEmbeddedReq name: "expiresAt", baseName: "expires_at", type: "number" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -20115,6 +20115,11 @@ var SignatureRequestEditEmbeddedWithTemplateRequest = class _SignatureRequestEdi name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", type: "boolean" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -20137,10 +20142,6 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ @@ -20192,11 +20193,6 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { baseName: "allow_decline", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "allowReassign", baseName: "allow_reassign", @@ -20296,6 +20292,11 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { name: "expiresAt", baseName: "expires_at", type: "number" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -20408,6 +20409,11 @@ var SignatureRequestEditWithTemplateRequest = class _SignatureRequestEditWithTem name: "title", baseName: "title", type: "string" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -20649,6 +20655,11 @@ var SignatureRequestResponse = class _SignatureRequestResponse { name: "bulkSendJobId", baseName: "bulk_send_job_id", type: "string" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SignatureRequestSignerExperience" } ]; } @@ -21411,10 +21422,6 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ this["allowReassign"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. */ @@ -21473,11 +21480,6 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { baseName: "allow_reassign", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "attachments", baseName: "attachments", @@ -21577,6 +21579,11 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { name: "expiresAt", baseName: "expires_at", type: "number" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -21700,6 +21707,11 @@ var SignatureRequestSendWithTemplateRequest = class _SignatureRequestSendWithTem name: "title", baseName: "title", type: "string" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -21715,6 +21727,41 @@ var SignatureRequestSendWithTemplateRequest = class _SignatureRequestSendWithTem } }; +// model/signatureRequestSignerExperience.ts +var SignatureRequestSignerExperience = class _SignatureRequestSignerExperience { + static { + this.discriminator = void 0; + } + static { + this.attributeTypeMap = [ + { + name: "formView", + baseName: "form_view", + type: "SignatureRequestSignerExperience.FormViewEnum" + } + ]; + } + static getAttributeTypeMap() { + return _SignatureRequestSignerExperience.attributeTypeMap; + } + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data) { + return ObjectSerializer.deserialize( + data, + "SignatureRequestSignerExperience" + ); + } +}; +((SignatureRequestSignerExperience2) => { + let FormViewEnum; + ((FormViewEnum2) => { + FormViewEnum2["Disabled"] = "disabled"; + FormViewEnum2["Enabled"] = "enabled"; + FormViewEnum2["EnabledByDefault"] = "enabled_by_default"; + FormViewEnum2["Forced"] = "forced"; + })(FormViewEnum = SignatureRequestSignerExperience2.FormViewEnum || (SignatureRequestSignerExperience2.FormViewEnum = {})); +})(SignatureRequestSignerExperience || (SignatureRequestSignerExperience = {})); + // model/signatureRequestUpdateRequest.ts var SignatureRequestUpdateRequest = class _SignatureRequestUpdateRequest { static { @@ -23156,6 +23203,38 @@ var SubSignatureRequestTemplateSigner = class _SubSignatureRequestTemplateSigner })(SmsPhoneNumberTypeEnum = SubSignatureRequestTemplateSigner2.SmsPhoneNumberTypeEnum || (SubSignatureRequestTemplateSigner2.SmsPhoneNumberTypeEnum = {})); })(SubSignatureRequestTemplateSigner || (SubSignatureRequestTemplateSigner = {})); +// model/subSignerExperience.ts +var SubSignerExperience = class _SubSignerExperience { + static { + this.discriminator = void 0; + } + static { + this.attributeTypeMap = [ + { + name: "formView", + baseName: "form_view", + type: "SubSignerExperience.FormViewEnum" + } + ]; + } + static getAttributeTypeMap() { + return _SubSignerExperience.attributeTypeMap; + } + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data) { + return ObjectSerializer.deserialize(data, "SubSignerExperience"); + } +}; +((SubSignerExperience2) => { + let FormViewEnum; + ((FormViewEnum2) => { + FormViewEnum2["Disabled"] = "disabled"; + FormViewEnum2["Enabled"] = "enabled"; + FormViewEnum2["EnabledByDefault"] = "enabled_by_default"; + FormViewEnum2["Forced"] = "forced"; + })(FormViewEnum = SubSignerExperience2.FormViewEnum || (SubSignerExperience2.FormViewEnum = {})); +})(SubSignerExperience || (SubSignerExperience = {})); + // model/subSigningOptions.ts var SubSigningOptions = class _SubSigningOptions { constructor() { @@ -24031,10 +24110,6 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ this["allowReassign"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Provide users the ability to review/edit the template signer roles. */ @@ -24094,11 +24169,6 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque baseName: "allow_reassign", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "attachments", baseName: "attachments", @@ -24198,6 +24268,11 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque name: "usePreexistingFields", baseName: "use_preexisting_fields", type: "boolean" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -24292,10 +24367,6 @@ var TemplateCreateRequest = class _TemplateCreateRequest { * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ this["allowReassign"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. */ @@ -24335,11 +24406,6 @@ var TemplateCreateRequest = class _TemplateCreateRequest { baseName: "allow_reassign", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "attachments", baseName: "attachments", @@ -24404,6 +24470,11 @@ var TemplateCreateRequest = class _TemplateCreateRequest { name: "usePreexistingFields", baseName: "use_preexisting_fields", type: "boolean" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -24644,9 +24715,9 @@ var TemplateResponse = class _TemplateResponse { type: "Array" }, { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" + name: "signerExperience", + baseName: "signer_experience", + type: "SignatureRequestSignerExperience" } ]; } @@ -26046,11 +26117,6 @@ var TemplateUpdateRequest = class _TemplateUpdateRequest { baseName: "cc_roles", type: "Array" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "title", baseName: "title", @@ -26070,6 +26136,11 @@ var TemplateUpdateRequest = class _TemplateUpdateRequest { name: "formFields", baseName: "form_fields", type: "Array" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -26093,10 +26164,6 @@ var UnclaimedDraftCreateEmbeddedRequest = class _UnclaimedDraftCreateEmbeddedReq * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ @@ -26185,11 +26252,6 @@ var UnclaimedDraftCreateEmbeddedRequest = class _UnclaimedDraftCreateEmbeddedReq baseName: "allow_decline", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "allowReassign", baseName: "allow_reassign", @@ -26593,10 +26655,6 @@ var UnclaimedDraftCreateRequest = class _UnclaimedDraftCreateRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ this["allowDecline"] = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - this["allowFormView"] = false; /** * Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. */ @@ -26643,11 +26701,6 @@ var UnclaimedDraftCreateRequest = class _UnclaimedDraftCreateRequest { baseName: "allow_decline", type: "boolean" }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean" - }, { name: "attachments", baseName: "attachments", @@ -26747,6 +26800,11 @@ var UnclaimedDraftCreateRequest = class _UnclaimedDraftCreateRequest { name: "expiresAt", baseName: "expires_at", type: "number" + }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience" } ]; } @@ -26953,6 +27011,7 @@ var enumsMap = { "ReportResponse.ReportTypeEnum": ReportResponse.ReportTypeEnum, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataTypeEnum, + "SignatureRequestSignerExperience.FormViewEnum": SignatureRequestSignerExperience.FormViewEnum, "SubFieldOptions.DateFormatEnum": SubFieldOptions.DateFormatEnum, "SubFormFieldRuleAction.TypeEnum": SubFormFieldRuleAction.TypeEnum, "SubFormFieldRuleTrigger.OperatorEnum": SubFormFieldRuleTrigger.OperatorEnum, @@ -26968,6 +27027,7 @@ var enumsMap = { "SubOAuth.ScopesEnum": SubOAuth.ScopesEnum, "SubSignatureRequestSigner.SmsPhoneNumberTypeEnum": SubSignatureRequestSigner.SmsPhoneNumberTypeEnum, "SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum": SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum, + "SubSignerExperience.FormViewEnum": SubSignerExperience.FormViewEnum, "SubSigningOptions.DefaultTypeEnum": SubSigningOptions.DefaultTypeEnum, "SubWhiteLabelingOptions.LegalVersionEnum": SubWhiteLabelingOptions.LegalVersionEnum, "TeamAddMemberRequest.RoleEnum": TeamAddMemberRequest.RoleEnum, @@ -27063,6 +27123,7 @@ var typeMap = { SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, + SignatureRequestSignerExperience, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, @@ -27092,6 +27153,7 @@ var typeMap = { SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, + SubSignerExperience, SubSigningOptions, SubTeamResponse, SubTemplateRole, @@ -36729,6 +36791,7 @@ var APIS = [ SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, + SignatureRequestSignerExperience, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, @@ -36760,6 +36823,7 @@ var APIS = [ SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, + SubSignerExperience, SubSigningOptions, SubTeamResponse, SubTemplateRole, diff --git a/sdks/node/docs/api/SignatureRequestApi.md b/sdks/node/docs/api/SignatureRequestApi.md index 04b197f7d..58a4ac40c 100644 --- a/sdks/node/docs/api/SignatureRequestApi.md +++ b/sdks/node/docs/api/SignatureRequestApi.md @@ -368,6 +368,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -399,6 +403,7 @@ const signatureRequestCreateEmbeddedRequest: models.SignatureRequestCreateEmbedd fs.createReadStream("./example_signature_request.pdf"), ], signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; @@ -465,6 +470,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", @@ -484,6 +493,7 @@ const signatureRequestCreateEmbeddedWithTemplateRequest: models.SignatureRequest subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; @@ -554,6 +564,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -589,6 +603,7 @@ const signatureRequestEditRequest: models.SignatureRequestEditRequest = { }, fieldOptions: fieldOptions, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; @@ -657,6 +672,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestSigner = { name: "Jack", emailAddress: "jack@example.com", @@ -688,6 +707,7 @@ const signatureRequestEditEmbeddedRequest: models.SignatureRequestEditEmbeddedRe fs.createReadStream("./example_signature_request.pdf"), ], signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; @@ -756,6 +776,10 @@ const signingOptions: models.SubSigningOptions = { upload: true, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signers1: models.SubSignatureRequestTemplateSigner = { role: "Client", name: "George", @@ -775,6 +799,7 @@ const signatureRequestEditEmbeddedWithTemplateRequest: models.SignatureRequestEd subject: "Purchase Order", testMode: true, signingOptions: signingOptions, + signerExperience: signerExperience, signers: signers, }; diff --git a/sdks/node/docs/api/TemplateApi.md b/sdks/node/docs/api/TemplateApi.md index 6fee7936f..486bb8253 100644 --- a/sdks/node/docs/api/TemplateApi.md +++ b/sdks/node/docs/api/TemplateApi.md @@ -104,6 +104,10 @@ const fieldOptions: models.SubFieldOptions = { dateFormat: models.SubFieldOptions.DateFormatEnum.DdMmYyyy, }; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const signerRoles1: models.SubTemplateRole = { name: "Client", order: 0, @@ -182,6 +186,7 @@ const templateCreateRequest: models.TemplateCreateRequest = { fs.createReadStream("./example_signature_request.pdf"), ], fieldOptions: fieldOptions, + signerExperience: signerExperience, signerRoles: signerRoles, formFieldsPerDocument: formFieldsPerDocument, mergeFields: mergeFields, @@ -747,6 +752,10 @@ const apiCaller = new api.TemplateApi(); apiCaller.username = "YOUR_API_KEY"; // apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; +const signerExperience: models.SubSignerExperience = { + formView: models.SubSignerExperience.FormViewEnum.Disabled, +}; + const formFields1: models.SubUpdateFormField = { apiId: "uniqueIdHere_1", name: "New name 1", @@ -763,7 +772,6 @@ const formFields = [ ]; const templateUpdateRequest: models.TemplateUpdateRequest = { - allowFormView: false, title: "Test Title", subject: "Test Subject", message: "Test Message", @@ -771,6 +779,7 @@ const templateUpdateRequest: models.TemplateUpdateRequest = { "CC Role 1", "CC Role 2", ], + signerExperience: signerExperience, formFields: formFields, }; diff --git a/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md b/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md index fe84b808e..86da2106e 100644 --- a/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/node/docs/model/BulkSendJobGetResponseSignatureRequests.md @@ -31,5 +31,6 @@ Name | Type | Description | Notes | `responseData` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulkSendJobId` | ```string``` | The id of the BulkSendJob. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/EmbeddedEditUrlRequest.md b/sdks/node/docs/model/EmbeddedEditUrlRequest.md index c19e59cde..b34b35e61 100644 --- a/sdks/node/docs/model/EmbeddedEditUrlRequest.md +++ b/sdks/node/docs/model/EmbeddedEditUrlRequest.md @@ -7,7 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `allowEditCcs` | ```boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `forceSignerRoles` | ```boolean``` | Provide users the ability to review/edit the template signer roles. | [default to false] | @@ -17,5 +16,6 @@ Name | Type | Description | Notes | `showPreview` | ```boolean``` | This allows the requester to enable the editor/preview experience. | [default to false] | | `showProgressStepper` | ```boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | | `testMode` | ```boolean``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to false] | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md index e58badd77..88a8ce310 100644 --- a/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | @@ -30,6 +29,7 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md index d440db010..70cc3adfc 100644 --- a/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -21,5 +21,6 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md index 57cc9072c..debf3046a 100644 --- a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | @@ -31,5 +30,6 @@ Name | Type | Description | Notes | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md index f417f0f72..ed981ddca 100644 --- a/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -21,5 +21,6 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestEditRequest.md b/sdks/node/docs/model/SignatureRequestEditRequest.md index 9101bceb8..50cab58b2 100644 --- a/sdks/node/docs/model/SignatureRequestEditRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | @@ -32,5 +31,6 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md index fdec2cfc0..d85393e5b 100644 --- a/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditWithTemplateRequest.md @@ -22,5 +22,6 @@ Name | Type | Description | Notes | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestResponse.md b/sdks/node/docs/model/SignatureRequestResponse.md index 8bf5449d0..96b27eb07 100644 --- a/sdks/node/docs/model/SignatureRequestResponse.md +++ b/sdks/node/docs/model/SignatureRequestResponse.md @@ -31,5 +31,6 @@ Name | Type | Description | Notes | `responseData` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulkSendJobId` | ```string``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestSendRequest.md b/sdks/node/docs/model/SignatureRequestSendRequest.md index 12c5ba689..dcc06f157 100644 --- a/sdks/node/docs/model/SignatureRequestSendRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `groupedSigners` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `clientId` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | @@ -33,5 +32,6 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md b/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md index 73d132e0b..6edef1966 100644 --- a/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendWithTemplateRequest.md @@ -23,5 +23,6 @@ Name | Type | Description | Notes | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestSignerExperience.md b/sdks/node/docs/model/SignatureRequestSignerExperience.md new file mode 100644 index 000000000..104ae72b5 --- /dev/null +++ b/sdks/node/docs/model/SignatureRequestSignerExperience.md @@ -0,0 +1,11 @@ +# # SignatureRequestSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `formView`*_required_ | ```string``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SubSignerExperience.md b/sdks/node/docs/model/SubSignerExperience.md new file mode 100644 index 000000000..599e0099e --- /dev/null +++ b/sdks/node/docs/model/SubSignerExperience.md @@ -0,0 +1,11 @@ +# # SubSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `formView` | ```string``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md index ac245615e..45cabf073 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -32,5 +31,6 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateCreateRequest.md b/sdks/node/docs/model/TemplateCreateRequest.md index a2c29278e..4cd4551f0 100644 --- a/sdks/node/docs/model/TemplateCreateRequest.md +++ b/sdks/node/docs/model/TemplateCreateRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `clientId` | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | @@ -25,5 +24,6 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponse.md b/sdks/node/docs/model/TemplateResponse.md index e8ebff2ec..1ba483280 100644 --- a/sdks/node/docs/model/TemplateResponse.md +++ b/sdks/node/docs/model/TemplateResponse.md @@ -22,6 +22,6 @@ Name | Type | Description | Notes | `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `signerExperience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateUpdateRequest.md b/sdks/node/docs/model/TemplateUpdateRequest.md index 68b4543ca..2d46dbd28 100644 --- a/sdks/node/docs/model/TemplateUpdateRequest.md +++ b/sdks/node/docs/model/TemplateUpdateRequest.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `ccRoles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request. | | -| `allowFormView` | ```boolean``` | The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. | | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `subject` | ```string``` | The new default template email subject. | | | `message` | ```string``` | The new default template email message. | | | `formFields` | [```Array```](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md index 618e12691..444d8d77c 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowCcs` | ```boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allowReassign` | ```boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md index c3bf22440..445967af5 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allowDecline` | ```boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allowFormView` | ```boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `ccEmailAddresses` | ```Array``` | The email addresses that should be CCed. | | | `clientId` | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | @@ -31,5 +30,6 @@ Name | Type | Description | Notes | `usePreexistingFields` | ```boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `useTextTags` | ```boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `signerExperience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts b/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts index 9ff1456f6..70bb561e7 100644 --- a/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts +++ b/sdks/node/model/bulkSendJobGetResponseSignatureRequests.ts @@ -27,6 +27,7 @@ import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAt import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSignatures"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; export class BulkSendJobGetResponseSignatureRequests { /** @@ -129,6 +130,7 @@ export class BulkSendJobGetResponseSignatureRequests { * The id of the BulkSendJob. */ "bulkSendJobId"?: string; + "signerExperience"?: SignatureRequestSignerExperience; static discriminator: string | undefined = undefined; @@ -258,6 +260,11 @@ export class BulkSendJobGetResponseSignatureRequests { baseName: "bulk_send_job_id", type: "string", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SignatureRequestSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/embeddedEditUrlRequest.ts b/sdks/node/model/embeddedEditUrlRequest.ts index 5548ef9bb..7a96ab574 100644 --- a/sdks/node/model/embeddedEditUrlRequest.ts +++ b/sdks/node/model/embeddedEditUrlRequest.ts @@ -25,16 +25,13 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { SubEditorOptions } from "./subEditorOptions"; import { SubMergeField } from "./subMergeField"; +import { SubSignerExperience } from "./subSignerExperience"; export class EmbeddedEditUrlRequest { /** * This allows the requester to enable/disable to add or change CC roles when editing the template. */ "allowEditCcs"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. */ @@ -68,6 +65,7 @@ export class EmbeddedEditUrlRequest { * Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. */ "testMode"?: boolean = false; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -77,11 +75,6 @@ export class EmbeddedEditUrlRequest { baseName: "allow_edit_ccs", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "ccRoles", baseName: "cc_roles", @@ -127,6 +120,11 @@ export class EmbeddedEditUrlRequest { baseName: "test_mode", type: "boolean", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/index.ts b/sdks/node/model/index.ts index 7b5badacb..302e55ecb 100644 --- a/sdks/node/model/index.ts +++ b/sdks/node/model/index.ts @@ -103,6 +103,7 @@ import { SignatureRequestResponseDataValueTextMerge } from "./signatureRequestRe import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSignatures"; import { SignatureRequestSendRequest } from "./signatureRequestSendRequest"; import { SignatureRequestSendWithTemplateRequest } from "./signatureRequestSendWithTemplateRequest"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; import { SignatureRequestUpdateRequest } from "./signatureRequestUpdateRequest"; import { SubAttachment } from "./subAttachment"; import { SubBulkSignerList } from "./subBulkSignerList"; @@ -134,6 +135,7 @@ import { SubOptions } from "./subOptions"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; import { SubTeamResponse } from "./subTeamResponse"; import { SubTemplateRole } from "./subTemplateRole"; @@ -221,6 +223,8 @@ export let enumsMap: { [index: string]: any } = { SignatureRequestResponseCustomFieldTypeEnum: SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataTypeEnum: SignatureRequestResponseDataTypeEnum, + "SignatureRequestSignerExperience.FormViewEnum": + SignatureRequestSignerExperience.FormViewEnum, "SubFieldOptions.DateFormatEnum": SubFieldOptions.DateFormatEnum, "SubFormFieldRuleAction.TypeEnum": SubFormFieldRuleAction.TypeEnum, "SubFormFieldRuleTrigger.OperatorEnum": SubFormFieldRuleTrigger.OperatorEnum, @@ -244,6 +248,7 @@ export let enumsMap: { [index: string]: any } = { SubSignatureRequestSigner.SmsPhoneNumberTypeEnum, "SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum": SubSignatureRequestTemplateSigner.SmsPhoneNumberTypeEnum, + "SubSignerExperience.FormViewEnum": SubSignerExperience.FormViewEnum, "SubSigningOptions.DefaultTypeEnum": SubSigningOptions.DefaultTypeEnum, "SubWhiteLabelingOptions.LegalVersionEnum": SubWhiteLabelingOptions.LegalVersionEnum, @@ -361,6 +366,7 @@ export let typeMap: { [index: string]: any } = { SignatureRequestSendRequest: SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest: SignatureRequestSendWithTemplateRequest, + SignatureRequestSignerExperience: SignatureRequestSignerExperience, SignatureRequestUpdateRequest: SignatureRequestUpdateRequest, SubAttachment: SubAttachment, SubBulkSignerList: SubBulkSignerList, @@ -390,6 +396,7 @@ export let typeMap: { [index: string]: any } = { SubSignatureRequestGroupedSigners: SubSignatureRequestGroupedSigners, SubSignatureRequestSigner: SubSignatureRequestSigner, SubSignatureRequestTemplateSigner: SubSignatureRequestTemplateSigner, + SubSignerExperience: SubSignerExperience, SubSigningOptions: SubSigningOptions, SubTeamResponse: SubTeamResponse, SubTemplateRole: SubTemplateRole, @@ -589,6 +596,7 @@ export { SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, + SignatureRequestSignerExperience, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, @@ -620,6 +628,7 @@ export { SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, + SubSignerExperience, SubSigningOptions, SubTeamResponse, SubTemplateRole, diff --git a/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts index 974ac6951..23e1a09a4 100644 --- a/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts @@ -31,6 +31,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export class SignatureRequestCreateEmbeddedRequest { @@ -58,10 +59,6 @@ export class SignatureRequestCreateEmbeddedRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ @@ -124,6 +121,7 @@ export class SignatureRequestCreateEmbeddedRequest { * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ "populateAutoFillFields"?: boolean = false; + "signerExperience"?: SubSignerExperience; /** * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. */ @@ -162,11 +160,6 @@ export class SignatureRequestCreateEmbeddedRequest { baseName: "allow_decline", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "allowReassign", baseName: "allow_reassign", @@ -252,6 +245,11 @@ export class SignatureRequestCreateEmbeddedRequest { baseName: "populate_auto_fill_fields", type: "boolean", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, { name: "expiresAt", baseName: "expires_at", diff --git a/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts b/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts index 08b7b6e58..e040c1253 100644 --- a/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestCreateEmbeddedWithTemplateRequest.ts @@ -26,6 +26,7 @@ import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export class SignatureRequestCreateEmbeddedWithTemplateRequest { @@ -86,6 +87,7 @@ export class SignatureRequestCreateEmbeddedWithTemplateRequest { * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ "populateAutoFillFields"?: boolean = false; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -165,6 +167,11 @@ export class SignatureRequestCreateEmbeddedWithTemplateRequest { baseName: "populate_auto_fill_fields", type: "boolean", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts index 268e9efbe..85db3b20f 100644 --- a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts @@ -31,6 +31,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export class SignatureRequestEditEmbeddedRequest { @@ -58,10 +59,6 @@ export class SignatureRequestEditEmbeddedRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. */ @@ -128,6 +125,7 @@ export class SignatureRequestEditEmbeddedRequest { * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. */ "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -162,11 +160,6 @@ export class SignatureRequestEditEmbeddedRequest { baseName: "allow_decline", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "allowReassign", baseName: "allow_reassign", @@ -257,6 +250,11 @@ export class SignatureRequestEditEmbeddedRequest { baseName: "expires_at", type: "number", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts index c007c76ca..72f04b2ad 100644 --- a/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestEditEmbeddedWithTemplateRequest.ts @@ -26,6 +26,7 @@ import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export class SignatureRequestEditEmbeddedWithTemplateRequest { @@ -86,6 +87,7 @@ export class SignatureRequestEditEmbeddedWithTemplateRequest { * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ "populateAutoFillFields"?: boolean = false; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -165,6 +167,11 @@ export class SignatureRequestEditEmbeddedWithTemplateRequest { baseName: "populate_auto_fill_fields", type: "boolean", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestEditRequest.ts b/sdks/node/model/signatureRequestEditRequest.ts index 06dc4e5b9..67af62629 100644 --- a/sdks/node/model/signatureRequestEditRequest.ts +++ b/sdks/node/model/signatureRequestEditRequest.ts @@ -31,6 +31,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export class SignatureRequestEditRequest { @@ -54,10 +55,6 @@ export class SignatureRequestEditRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ @@ -132,6 +129,7 @@ export class SignatureRequestEditRequest { * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. */ "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -161,11 +159,6 @@ export class SignatureRequestEditRequest { baseName: "allow_decline", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "allowReassign", baseName: "allow_reassign", @@ -266,6 +259,11 @@ export class SignatureRequestEditRequest { baseName: "expires_at", type: "number", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestEditWithTemplateRequest.ts b/sdks/node/model/signatureRequestEditWithTemplateRequest.ts index f35af5999..0b7aef17b 100644 --- a/sdks/node/model/signatureRequestEditWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestEditWithTemplateRequest.ts @@ -26,6 +26,7 @@ import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; /** @@ -93,6 +94,7 @@ export class SignatureRequestEditWithTemplateRequest { * The title you want to assign to the SignatureRequest. */ "title"?: string; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -177,6 +179,11 @@ export class SignatureRequestEditWithTemplateRequest { baseName: "title", type: "string", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestResponse.ts b/sdks/node/model/signatureRequestResponse.ts index 014da962b..295c64266 100644 --- a/sdks/node/model/signatureRequestResponse.ts +++ b/sdks/node/model/signatureRequestResponse.ts @@ -27,6 +27,7 @@ import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAt import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSignatures"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; /** * Contains information about a signature request. @@ -132,6 +133,7 @@ export class SignatureRequestResponse { * The ID of the Bulk Send job which sent the signature request, if applicable. */ "bulkSendJobId"?: string | null; + "signerExperience"?: SignatureRequestSignerExperience; static discriminator: string | undefined = undefined; @@ -261,6 +263,11 @@ export class SignatureRequestResponse { baseName: "bulk_send_job_id", type: "string", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SignatureRequestSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestSendRequest.ts b/sdks/node/model/signatureRequestSendRequest.ts index 2bb32dd4e..46815d66d 100644 --- a/sdks/node/model/signatureRequestSendRequest.ts +++ b/sdks/node/model/signatureRequestSendRequest.ts @@ -31,6 +31,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export class SignatureRequestSendRequest { @@ -58,10 +59,6 @@ export class SignatureRequestSendRequest { * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ "allowReassign"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * A list describing the attachments */ @@ -138,6 +135,7 @@ export class SignatureRequestSendRequest { * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. */ "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -172,11 +170,6 @@ export class SignatureRequestSendRequest { baseName: "allow_reassign", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "attachments", baseName: "attachments", @@ -277,6 +270,11 @@ export class SignatureRequestSendRequest { baseName: "expires_at", type: "number", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestSendWithTemplateRequest.ts b/sdks/node/model/signatureRequestSendWithTemplateRequest.ts index 12232a129..4281f5d99 100644 --- a/sdks/node/model/signatureRequestSendWithTemplateRequest.ts +++ b/sdks/node/model/signatureRequestSendWithTemplateRequest.ts @@ -26,6 +26,7 @@ import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; /** @@ -99,6 +100,7 @@ export class SignatureRequestSendWithTemplateRequest { * The title you want to assign to the SignatureRequest. */ "title"?: string; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -188,6 +190,11 @@ export class SignatureRequestSendWithTemplateRequest { baseName: "title", type: "string", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/signatureRequestSignerExperience.ts b/sdks/node/model/signatureRequestSignerExperience.ts new file mode 100644 index 000000000..3b38d7984 --- /dev/null +++ b/sdks/node/model/signatureRequestSignerExperience.ts @@ -0,0 +1,66 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; + +/** + * Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + */ +export class SignatureRequestSignerExperience { + /** + * Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + */ + "formView": SignatureRequestSignerExperience.FormViewEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "formView", + baseName: "form_view", + type: "SignatureRequestSignerExperience.FormViewEnum", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return SignatureRequestSignerExperience.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): SignatureRequestSignerExperience { + return ObjectSerializer.deserialize( + data, + "SignatureRequestSignerExperience" + ); + } +} + +export namespace SignatureRequestSignerExperience { + export enum FormViewEnum { + Disabled = "disabled", + Enabled = "enabled", + EnabledByDefault = "enabled_by_default", + Forced = "forced", + } +} diff --git a/sdks/node/model/subSignerExperience.ts b/sdks/node/model/subSignerExperience.ts new file mode 100644 index 000000000..0d262906c --- /dev/null +++ b/sdks/node/model/subSignerExperience.ts @@ -0,0 +1,63 @@ +/** + * The MIT License (MIT) + * + * Copyright (C) 2023 dropbox.com + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +import { AttributeTypeMap, ObjectSerializer } from "./"; + +/** + * Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + */ +export class SubSignerExperience { + /** + * Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + */ + "formView"?: SubSignerExperience.FormViewEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: AttributeTypeMap = [ + { + name: "formView", + baseName: "form_view", + type: "SubSignerExperience.FormViewEnum", + }, + ]; + + static getAttributeTypeMap(): AttributeTypeMap { + return SubSignerExperience.attributeTypeMap; + } + + /** Attempt to instantiate and hydrate a new instance of this class */ + static init(data: any): SubSignerExperience { + return ObjectSerializer.deserialize(data, "SubSignerExperience"); + } +} + +export namespace SubSignerExperience { + export enum FormViewEnum { + Disabled = "disabled", + Enabled = "enabled", + EnabledByDefault = "enabled_by_default", + Forced = "forced", + } +} diff --git a/sdks/node/model/templateCreateEmbeddedDraftRequest.ts b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts index aebfaae1e..d33280813 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftRequest.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts @@ -30,6 +30,7 @@ import { SubFormFieldGroup } from "./subFormFieldGroup"; import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubMergeField } from "./subMergeField"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubTemplateRole } from "./subTemplateRole"; export class TemplateCreateEmbeddedDraftRequest { @@ -53,10 +54,6 @@ export class TemplateCreateEmbeddedDraftRequest { * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ "allowReassign"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * A list describing the attachments */ @@ -131,6 +128,7 @@ export class TemplateCreateEmbeddedDraftRequest { * Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). */ "usePreexistingFields"?: boolean = false; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -160,11 +158,6 @@ export class TemplateCreateEmbeddedDraftRequest { baseName: "allow_reassign", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "attachments", baseName: "attachments", @@ -265,6 +258,11 @@ export class TemplateCreateEmbeddedDraftRequest { baseName: "use_preexisting_fields", type: "boolean", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateCreateRequest.ts b/sdks/node/model/templateCreateRequest.ts index 7a334774b..476e21249 100644 --- a/sdks/node/model/templateCreateRequest.ts +++ b/sdks/node/model/templateCreateRequest.ts @@ -29,6 +29,7 @@ import { SubFormFieldGroup } from "./subFormFieldGroup"; import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubMergeField } from "./subMergeField"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubTemplateRole } from "./subTemplateRole"; export class TemplateCreateRequest { @@ -52,10 +53,6 @@ export class TemplateCreateRequest { * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ "allowReassign"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * A list describing the attachments */ @@ -105,6 +102,7 @@ export class TemplateCreateRequest { * Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). */ "usePreexistingFields"?: boolean = false; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -134,11 +132,6 @@ export class TemplateCreateRequest { baseName: "allow_reassign", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "attachments", baseName: "attachments", @@ -204,6 +197,11 @@ export class TemplateCreateRequest { baseName: "use_preexisting_fields", type: "boolean", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponse.ts b/sdks/node/model/templateResponse.ts index 322066a21..df46b2167 100644 --- a/sdks/node/model/templateResponse.ts +++ b/sdks/node/model/templateResponse.ts @@ -24,6 +24,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -103,10 +104,7 @@ export class TemplateResponse { * Signer attachments. */ "attachments"?: Array; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean; + "signerExperience"?: SignatureRequestSignerExperience; static discriminator: string | undefined = undefined; @@ -192,9 +190,9 @@ export class TemplateResponse { type: "Array", }, { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", + name: "signerExperience", + baseName: "signer_experience", + type: "SignatureRequestSignerExperience", }, ]; diff --git a/sdks/node/model/templateUpdateRequest.ts b/sdks/node/model/templateUpdateRequest.ts index b6e94e6e0..c7c0d57fa 100644 --- a/sdks/node/model/templateUpdateRequest.ts +++ b/sdks/node/model/templateUpdateRequest.ts @@ -23,6 +23,7 @@ */ import { AttributeTypeMap, ObjectSerializer } from "./"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubUpdateFormField } from "./subUpdateFormField"; export class TemplateUpdateRequest { @@ -30,10 +31,6 @@ export class TemplateUpdateRequest { * The CC roles that must be assigned when using the template to send a signature request. */ "ccRoles"?: Array; - /** - * The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. - */ - "allowFormView"?: boolean; /** * The title you want to assign to the SignatureRequest. */ @@ -50,6 +47,7 @@ export class TemplateUpdateRequest { * A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. */ "formFields"?: Array; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -59,11 +57,6 @@ export class TemplateUpdateRequest { baseName: "cc_roles", type: "Array", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "title", baseName: "title", @@ -84,6 +77,11 @@ export class TemplateUpdateRequest { baseName: "form_fields", type: "Array", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts index 8ae381e22..950f3c5c1 100644 --- a/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts @@ -61,10 +61,6 @@ export class UnclaimedDraftCreateEmbeddedRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. */ @@ -211,11 +207,6 @@ export class UnclaimedDraftCreateEmbeddedRequest { baseName: "allow_decline", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "allowReassign", baseName: "allow_reassign", diff --git a/sdks/node/model/unclaimedDraftCreateRequest.ts b/sdks/node/model/unclaimedDraftCreateRequest.ts index 61aefcd55..576f43bc4 100644 --- a/sdks/node/model/unclaimedDraftCreateRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateRequest.ts @@ -29,6 +29,7 @@ import { SubFieldOptions } from "./subFieldOptions"; import { SubFormFieldGroup } from "./subFormFieldGroup"; import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; import { SubUnclaimedDraftSigner } from "./subUnclaimedDraftSigner"; @@ -52,10 +53,6 @@ export class UnclaimedDraftCreateRequest { * Allows signers to decline to sign a document if `true`. Defaults to `false`. */ "allowDecline"?: boolean = false; - /** - * Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - */ - "allowFormView"?: boolean = false; /** * A list describing the attachments */ @@ -130,6 +127,7 @@ export class UnclaimedDraftCreateRequest { * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. */ "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined = undefined; @@ -154,11 +152,6 @@ export class UnclaimedDraftCreateRequest { baseName: "allow_decline", type: "boolean", }, - { - name: "allowFormView", - baseName: "allow_form_view", - type: "boolean", - }, { name: "attachments", baseName: "attachments", @@ -259,6 +252,11 @@ export class UnclaimedDraftCreateRequest { baseName: "expires_at", type: "number", }, + { + name: "signerExperience", + baseName: "signer_experience", + type: "SubSignerExperience", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/types/model/bulkSendJobGetResponseSignatureRequests.d.ts b/sdks/node/types/model/bulkSendJobGetResponseSignatureRequests.d.ts index 8f20a3fec..fd640f966 100644 --- a/sdks/node/types/model/bulkSendJobGetResponseSignatureRequests.d.ts +++ b/sdks/node/types/model/bulkSendJobGetResponseSignatureRequests.d.ts @@ -3,6 +3,7 @@ import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAt import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSignatures"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; export declare class BulkSendJobGetResponseSignatureRequests { "testMode"?: boolean; "signatureRequestId"?: string; @@ -31,6 +32,7 @@ export declare class BulkSendJobGetResponseSignatureRequests { "responseData"?: Array | null; "signatures"?: Array; "bulkSendJobId"?: string; + "signerExperience"?: SignatureRequestSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/embeddedEditUrlRequest.d.ts b/sdks/node/types/model/embeddedEditUrlRequest.d.ts index 5a4614a93..56aec5530 100644 --- a/sdks/node/types/model/embeddedEditUrlRequest.d.ts +++ b/sdks/node/types/model/embeddedEditUrlRequest.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; import { SubEditorOptions } from "./subEditorOptions"; import { SubMergeField } from "./subMergeField"; +import { SubSignerExperience } from "./subSignerExperience"; export declare class EmbeddedEditUrlRequest { "allowEditCcs"?: boolean; - "allowFormView"?: boolean; "ccRoles"?: Array; "editorOptions"?: SubEditorOptions; "forceSignerRoles"?: boolean; @@ -13,6 +13,7 @@ export declare class EmbeddedEditUrlRequest { "showPreview"?: boolean; "showProgressStepper"?: boolean; "testMode"?: boolean; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/index.d.ts b/sdks/node/types/model/index.d.ts index e34120091..6ed6f1738 100644 --- a/sdks/node/types/model/index.d.ts +++ b/sdks/node/types/model/index.d.ts @@ -91,6 +91,7 @@ import { SignatureRequestResponseDataValueTextMerge } from "./signatureRequestRe import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSignatures"; import { SignatureRequestSendRequest } from "./signatureRequestSendRequest"; import { SignatureRequestSendWithTemplateRequest } from "./signatureRequestSendWithTemplateRequest"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; import { SignatureRequestUpdateRequest } from "./signatureRequestUpdateRequest"; import { SubAttachment } from "./subAttachment"; import { SubBulkSignerList } from "./subBulkSignerList"; @@ -122,6 +123,7 @@ import { SubOptions } from "./subOptions"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; import { SubTeamResponse } from "./subTeamResponse"; import { SubTemplateRole } from "./subTemplateRole"; @@ -200,4 +202,4 @@ export declare let enumsMap: { export declare let typeMap: { [index: string]: any; }; -export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseSettings, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FaxListResponse, FaxResponse, FaxResponseTransmission, FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestEditEmbeddedRequest, SignatureRequestEditEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubUpdateFormField, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, TemplateUpdateRequest, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; +export { AccountCreateRequest, AccountCreateResponse, AccountGetResponse, AccountResponse, AccountResponseQuotas, AccountResponseSettings, AccountResponseUsage, AccountUpdateRequest, AccountVerifyRequest, AccountVerifyResponse, AccountVerifyResponseAccount, ApiAppCreateRequest, ApiAppGetResponse, ApiAppListResponse, ApiAppResponse, ApiAppResponseOAuth, ApiAppResponseOptions, ApiAppResponseOwnerAccount, ApiAppResponseWhiteLabelingOptions, ApiAppUpdateRequest, ApiKeyAuth, AttributeTypeMap, Authentication, BulkSendJobGetResponse, BulkSendJobGetResponseSignatureRequests, BulkSendJobListResponse, BulkSendJobResponse, BulkSendJobSendResponse, EmbeddedEditUrlRequest, EmbeddedEditUrlResponse, EmbeddedEditUrlResponseEmbedded, EmbeddedSignUrlResponse, EmbeddedSignUrlResponseEmbedded, ErrorResponse, ErrorResponseError, EventCallbackHelper, EventCallbackRequest, EventCallbackRequestEvent, EventCallbackRequestEventMetadata, FaxGetResponse, FaxLineAddUserRequest, FaxLineAreaCodeGetCountryEnum, FaxLineAreaCodeGetProvinceEnum, FaxLineAreaCodeGetResponse, FaxLineAreaCodeGetStateEnum, FaxLineCreateRequest, FaxLineDeleteRequest, FaxLineListResponse, FaxLineRemoveUserRequest, FaxLineResponse, FaxLineResponseFaxLine, FaxListResponse, FaxResponse, FaxResponseTransmission, FaxSendRequest, FileResponse, FileResponseDataUri, HttpBasicAuth, HttpBearerAuth, Interceptor, ListInfoResponse, OAuth, OAuthTokenGenerateRequest, OAuthTokenRefreshRequest, OAuthTokenResponse, ObjectSerializer, ReportCreateRequest, ReportCreateResponse, ReportResponse, RequestDetailedFile, RequestFile, SignatureRequestBulkCreateEmbeddedWithTemplateRequest, SignatureRequestBulkSendWithTemplateRequest, SignatureRequestCreateEmbeddedRequest, SignatureRequestCreateEmbeddedWithTemplateRequest, SignatureRequestEditEmbeddedRequest, SignatureRequestEditEmbeddedWithTemplateRequest, SignatureRequestEditRequest, SignatureRequestEditWithTemplateRequest, SignatureRequestGetResponse, SignatureRequestListResponse, SignatureRequestRemindRequest, SignatureRequestResponse, SignatureRequestResponseAttachment, SignatureRequestResponseCustomFieldBase, SignatureRequestResponseCustomFieldCheckbox, SignatureRequestResponseCustomFieldText, SignatureRequestResponseCustomFieldTypeEnum, SignatureRequestResponseDataBase, SignatureRequestResponseDataTypeEnum, SignatureRequestResponseDataValueCheckbox, SignatureRequestResponseDataValueCheckboxMerge, SignatureRequestResponseDataValueDateSigned, SignatureRequestResponseDataValueDropdown, SignatureRequestResponseDataValueInitials, SignatureRequestResponseDataValueRadio, SignatureRequestResponseDataValueSignature, SignatureRequestResponseDataValueText, SignatureRequestResponseDataValueTextMerge, SignatureRequestResponseSignatures, SignatureRequestSendRequest, SignatureRequestSendWithTemplateRequest, SignatureRequestSignerExperience, SignatureRequestUpdateRequest, SubAttachment, SubBulkSignerList, SubBulkSignerListCustomField, SubCC, SubCustomField, SubEditorOptions, SubFieldOptions, SubFormFieldGroup, SubFormFieldRule, SubFormFieldRuleAction, SubFormFieldRuleTrigger, SubFormFieldsPerDocumentBase, SubFormFieldsPerDocumentCheckbox, SubFormFieldsPerDocumentCheckboxMerge, SubFormFieldsPerDocumentDateSigned, SubFormFieldsPerDocumentDropdown, SubFormFieldsPerDocumentFontEnum, SubFormFieldsPerDocumentHyperlink, SubFormFieldsPerDocumentInitials, SubFormFieldsPerDocumentRadio, SubFormFieldsPerDocumentSignature, SubFormFieldsPerDocumentText, SubFormFieldsPerDocumentTextMerge, SubFormFieldsPerDocumentTypeEnum, SubMergeField, SubOAuth, SubOptions, SubSignatureRequestGroupedSigners, SubSignatureRequestSigner, SubSignatureRequestTemplateSigner, SubSignerExperience, SubSigningOptions, SubTeamResponse, SubTemplateRole, SubUnclaimedDraftSigner, SubUnclaimedDraftTemplateSigner, SubUpdateFormField, SubWhiteLabelingOptions, TeamAddMemberRequest, TeamCreateRequest, TeamGetInfoResponse, TeamGetResponse, TeamInfoResponse, TeamInviteResponse, TeamInvitesResponse, TeamMemberResponse, TeamMembersResponse, TeamParentResponse, TeamRemoveMemberRequest, TeamResponse, TeamSubTeamsResponse, TeamUpdateRequest, TemplateAddUserRequest, TemplateCreateEmbeddedDraftRequest, TemplateCreateEmbeddedDraftResponse, TemplateCreateEmbeddedDraftResponseTemplate, TemplateCreateRequest, TemplateCreateResponse, TemplateCreateResponseTemplate, TemplateGetResponse, TemplateListResponse, TemplateRemoveUserRequest, TemplateResponse, TemplateResponseAccount, TemplateResponseAccountQuota, TemplateResponseCCRole, TemplateResponseDocument, TemplateResponseDocumentCustomFieldBase, TemplateResponseDocumentCustomFieldCheckbox, TemplateResponseDocumentCustomFieldText, TemplateResponseDocumentFieldGroup, TemplateResponseDocumentFieldGroupRule, TemplateResponseDocumentFormFieldBase, TemplateResponseDocumentFormFieldCheckbox, TemplateResponseDocumentFormFieldDateSigned, TemplateResponseDocumentFormFieldDropdown, TemplateResponseDocumentFormFieldHyperlink, TemplateResponseDocumentFormFieldInitials, TemplateResponseDocumentFormFieldRadio, TemplateResponseDocumentFormFieldSignature, TemplateResponseDocumentFormFieldText, TemplateResponseDocumentStaticFieldBase, TemplateResponseDocumentStaticFieldCheckbox, TemplateResponseDocumentStaticFieldDateSigned, TemplateResponseDocumentStaticFieldDropdown, TemplateResponseDocumentStaticFieldHyperlink, TemplateResponseDocumentStaticFieldInitials, TemplateResponseDocumentStaticFieldRadio, TemplateResponseDocumentStaticFieldSignature, TemplateResponseDocumentStaticFieldText, TemplateResponseFieldAvgTextLength, TemplateResponseSignerRole, TemplateUpdateFilesRequest, TemplateUpdateFilesResponse, TemplateUpdateFilesResponseTemplate, TemplateUpdateRequest, UnclaimedDraftCreateEmbeddedRequest, UnclaimedDraftCreateEmbeddedWithTemplateRequest, UnclaimedDraftCreateRequest, UnclaimedDraftCreateResponse, UnclaimedDraftEditAndResendRequest, UnclaimedDraftResponse, VoidAuth, WarningResponse, }; diff --git a/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts b/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts index 3c3f58e05..be79836c2 100644 --- a/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts +++ b/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts @@ -7,6 +7,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestCreateEmbeddedRequest { "clientId": string; @@ -15,7 +16,6 @@ export declare class SignatureRequestCreateEmbeddedRequest { "signers"?: Array; "groupedSigners"?: Array; "allowDecline"?: boolean; - "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; @@ -35,6 +35,7 @@ export declare class SignatureRequestCreateEmbeddedRequest { "title"?: string; "useTextTags"?: boolean; "populateAutoFillFields"?: boolean; + "signerExperience"?: SubSignerExperience; "expiresAt"?: number | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestCreateEmbeddedWithTemplateRequest.d.ts b/sdks/node/types/model/signatureRequestCreateEmbeddedWithTemplateRequest.d.ts index a707ac1a9..fc700d4ee 100644 --- a/sdks/node/types/model/signatureRequestCreateEmbeddedWithTemplateRequest.d.ts +++ b/sdks/node/types/model/signatureRequestCreateEmbeddedWithTemplateRequest.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestCreateEmbeddedWithTemplateRequest { "templateIds": Array; @@ -21,6 +22,7 @@ export declare class SignatureRequestCreateEmbeddedWithTemplateRequest { "testMode"?: boolean; "title"?: string; "populateAutoFillFields"?: boolean; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts index 84d7c3e60..cac4434cd 100644 --- a/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts @@ -7,6 +7,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestEditEmbeddedRequest { "clientId": string; @@ -15,7 +16,6 @@ export declare class SignatureRequestEditEmbeddedRequest { "signers"?: Array; "groupedSigners"?: Array; "allowDecline"?: boolean; - "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; @@ -36,6 +36,7 @@ export declare class SignatureRequestEditEmbeddedRequest { "useTextTags"?: boolean; "populateAutoFillFields"?: boolean; "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts b/sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts index 6824ad17f..572c9a768 100644 --- a/sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditEmbeddedWithTemplateRequest.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestEditEmbeddedWithTemplateRequest { "templateIds": Array; @@ -21,6 +22,7 @@ export declare class SignatureRequestEditEmbeddedWithTemplateRequest { "testMode"?: boolean; "title"?: string; "populateAutoFillFields"?: boolean; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestEditRequest.d.ts b/sdks/node/types/model/signatureRequestEditRequest.d.ts index d80059a14..cad379efc 100644 --- a/sdks/node/types/model/signatureRequestEditRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditRequest.d.ts @@ -7,6 +7,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestEditRequest { "files"?: Array; @@ -14,7 +15,6 @@ export declare class SignatureRequestEditRequest { "signers"?: Array; "groupedSigners"?: Array; "allowDecline"?: boolean; - "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; @@ -37,6 +37,7 @@ export declare class SignatureRequestEditRequest { "title"?: string; "useTextTags"?: boolean; "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts b/sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts index 5dc2d730a..613246616 100644 --- a/sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditWithTemplateRequest.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestEditWithTemplateRequest { "templateIds": Array; @@ -22,6 +23,7 @@ export declare class SignatureRequestEditWithTemplateRequest { "subject"?: string; "testMode"?: boolean; "title"?: string; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestResponse.d.ts b/sdks/node/types/model/signatureRequestResponse.d.ts index a7420b6e9..20b9788e1 100644 --- a/sdks/node/types/model/signatureRequestResponse.d.ts +++ b/sdks/node/types/model/signatureRequestResponse.d.ts @@ -3,6 +3,7 @@ import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAt import { SignatureRequestResponseCustomFieldBase } from "./signatureRequestResponseCustomFieldBase"; import { SignatureRequestResponseDataBase } from "./signatureRequestResponseDataBase"; import { SignatureRequestResponseSignatures } from "./signatureRequestResponseSignatures"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; export declare class SignatureRequestResponse { "testMode"?: boolean; "signatureRequestId"?: string; @@ -31,6 +32,7 @@ export declare class SignatureRequestResponse { "responseData"?: Array | null; "signatures"?: Array; "bulkSendJobId"?: string | null; + "signerExperience"?: SignatureRequestSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestSendRequest.d.ts b/sdks/node/types/model/signatureRequestSendRequest.d.ts index 0f26f0697..180deda9c 100644 --- a/sdks/node/types/model/signatureRequestSendRequest.d.ts +++ b/sdks/node/types/model/signatureRequestSendRequest.d.ts @@ -7,6 +7,7 @@ import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubSignatureRequestGroupedSigners } from "./subSignatureRequestGroupedSigners"; import { SubSignatureRequestSigner } from "./subSignatureRequestSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestSendRequest { "files"?: Array; @@ -15,7 +16,6 @@ export declare class SignatureRequestSendRequest { "groupedSigners"?: Array; "allowDecline"?: boolean; "allowReassign"?: boolean; - "allowFormView"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; "clientId"?: string; @@ -38,6 +38,7 @@ export declare class SignatureRequestSendRequest { "title"?: string; "useTextTags"?: boolean; "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts b/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts index 3bacfad01..f333eb240 100644 --- a/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts +++ b/sdks/node/types/model/signatureRequestSendWithTemplateRequest.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap, RequestFile } from "./"; import { SubCC } from "./subCC"; import { SubCustomField } from "./subCustomField"; import { SubSignatureRequestTemplateSigner } from "./subSignatureRequestTemplateSigner"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; export declare class SignatureRequestSendWithTemplateRequest { "templateIds": Array; @@ -23,6 +24,7 @@ export declare class SignatureRequestSendWithTemplateRequest { "subject"?: string; "testMode"?: boolean; "title"?: string; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestSignerExperience.d.ts b/sdks/node/types/model/signatureRequestSignerExperience.d.ts new file mode 100644 index 000000000..46f81da2b --- /dev/null +++ b/sdks/node/types/model/signatureRequestSignerExperience.d.ts @@ -0,0 +1,16 @@ +import { AttributeTypeMap } from "./"; +export declare class SignatureRequestSignerExperience { + "formView": SignatureRequestSignerExperience.FormViewEnum; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): SignatureRequestSignerExperience; +} +export declare namespace SignatureRequestSignerExperience { + enum FormViewEnum { + Disabled = "disabled", + Enabled = "enabled", + EnabledByDefault = "enabled_by_default", + Forced = "forced" + } +} diff --git a/sdks/node/types/model/subSignerExperience.d.ts b/sdks/node/types/model/subSignerExperience.d.ts new file mode 100644 index 000000000..ee845478c --- /dev/null +++ b/sdks/node/types/model/subSignerExperience.d.ts @@ -0,0 +1,16 @@ +import { AttributeTypeMap } from "./"; +export declare class SubSignerExperience { + "formView"?: SubSignerExperience.FormViewEnum; + static discriminator: string | undefined; + static attributeTypeMap: AttributeTypeMap; + static getAttributeTypeMap(): AttributeTypeMap; + static init(data: any): SubSignerExperience; +} +export declare namespace SubSignerExperience { + enum FormViewEnum { + Disabled = "disabled", + Enabled = "enabled", + EnabledByDefault = "enabled_by_default", + Forced = "forced" + } +} diff --git a/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts b/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts index d6165569c..a168a1d44 100644 --- a/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts +++ b/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts @@ -6,6 +6,7 @@ import { SubFormFieldGroup } from "./subFormFieldGroup"; import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubMergeField } from "./subMergeField"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubTemplateRole } from "./subTemplateRole"; export declare class TemplateCreateEmbeddedDraftRequest { "clientId": string; @@ -13,7 +14,6 @@ export declare class TemplateCreateEmbeddedDraftRequest { "fileUrls"?: Array; "allowCcs"?: boolean; "allowReassign"?: boolean; - "allowFormView"?: boolean; "attachments"?: Array; "ccRoles"?: Array; "editorOptions"?: SubEditorOptions; @@ -36,6 +36,7 @@ export declare class TemplateCreateEmbeddedDraftRequest { "testMode"?: boolean; "title"?: string; "usePreexistingFields"?: boolean; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateRequest.d.ts b/sdks/node/types/model/templateCreateRequest.d.ts index f198ea8de..5574f2bda 100644 --- a/sdks/node/types/model/templateCreateRequest.d.ts +++ b/sdks/node/types/model/templateCreateRequest.d.ts @@ -5,6 +5,7 @@ import { SubFormFieldGroup } from "./subFormFieldGroup"; import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; import { SubMergeField } from "./subMergeField"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubTemplateRole } from "./subTemplateRole"; export declare class TemplateCreateRequest { "formFieldsPerDocument": Array; @@ -12,7 +13,6 @@ export declare class TemplateCreateRequest { "files"?: Array; "fileUrls"?: Array; "allowReassign"?: boolean; - "allowFormView"?: boolean; "attachments"?: Array; "ccRoles"?: Array; "clientId"?: string; @@ -28,6 +28,7 @@ export declare class TemplateCreateRequest { "testMode"?: boolean; "title"?: string; "usePreexistingFields"?: boolean; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponse.d.ts b/sdks/node/types/model/templateResponse.d.ts index 34496c128..1b465f6ad 100644 --- a/sdks/node/types/model/templateResponse.d.ts +++ b/sdks/node/types/model/templateResponse.d.ts @@ -1,5 +1,6 @@ import { AttributeTypeMap } from "./"; import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; +import { SignatureRequestSignerExperience } from "./signatureRequestSignerExperience"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -25,7 +26,7 @@ export declare class TemplateResponse { "namedFormFields"?: Array | null; "accounts"?: Array; "attachments"?: Array; - "allowFormView"?: boolean; + "signerExperience"?: SignatureRequestSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateUpdateRequest.d.ts b/sdks/node/types/model/templateUpdateRequest.d.ts index ff23398e1..106c45f7c 100644 --- a/sdks/node/types/model/templateUpdateRequest.d.ts +++ b/sdks/node/types/model/templateUpdateRequest.d.ts @@ -1,12 +1,13 @@ import { AttributeTypeMap } from "./"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubUpdateFormField } from "./subUpdateFormField"; export declare class TemplateUpdateRequest { "ccRoles"?: Array; - "allowFormView"?: boolean; "title"?: string; "subject"?: string; "message"?: string; "formFields"?: Array; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts b/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts index 3867d6dbc..1b48b08e1 100644 --- a/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts +++ b/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts @@ -15,7 +15,6 @@ export declare class UnclaimedDraftCreateEmbeddedRequest { "fileUrls"?: Array; "allowCcs"?: boolean; "allowDecline"?: boolean; - "allowFormView"?: boolean; "allowReassign"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; diff --git a/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts b/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts index 7dc8008db..760bc24bb 100644 --- a/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts +++ b/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts @@ -5,6 +5,7 @@ import { SubFieldOptions } from "./subFieldOptions"; import { SubFormFieldGroup } from "./subFormFieldGroup"; import { SubFormFieldRule } from "./subFormFieldRule"; import { SubFormFieldsPerDocumentBase } from "./subFormFieldsPerDocumentBase"; +import { SubSignerExperience } from "./subSignerExperience"; import { SubSigningOptions } from "./subSigningOptions"; import { SubUnclaimedDraftSigner } from "./subUnclaimedDraftSigner"; export declare class UnclaimedDraftCreateRequest { @@ -12,7 +13,6 @@ export declare class UnclaimedDraftCreateRequest { "files"?: Array; "fileUrls"?: Array; "allowDecline"?: boolean; - "allowFormView"?: boolean; "attachments"?: Array; "ccEmailAddresses"?: Array; "clientId"?: string; @@ -35,6 +35,7 @@ export declare class UnclaimedDraftCreateRequest { "usePreexistingFields"?: boolean; "useTextTags"?: boolean; "expiresAt"?: number | null; + "signerExperience"?: SubSignerExperience; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/README.md b/sdks/php/README.md index 30c3cc8f7..956a4e21b 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -316,6 +316,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SignatureRequestResponseSignatures](docs/Model/SignatureRequestResponseSignatures.md) - [SignatureRequestSendRequest](docs/Model/SignatureRequestSendRequest.md) - [SignatureRequestSendWithTemplateRequest](docs/Model/SignatureRequestSendWithTemplateRequest.md) +- [SignatureRequestSignerExperience](docs/Model/SignatureRequestSignerExperience.md) - [SignatureRequestUpdateRequest](docs/Model/SignatureRequestUpdateRequest.md) - [SubAttachment](docs/Model/SubAttachment.md) - [SubBulkSignerList](docs/Model/SubBulkSignerList.md) @@ -347,6 +348,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [SubSignatureRequestGroupedSigners](docs/Model/SubSignatureRequestGroupedSigners.md) - [SubSignatureRequestSigner](docs/Model/SubSignatureRequestSigner.md) - [SubSignatureRequestTemplateSigner](docs/Model/SubSignatureRequestTemplateSigner.md) +- [SubSignerExperience](docs/Model/SubSignerExperience.md) - [SubSigningOptions](docs/Model/SubSigningOptions.md) - [SubTeamResponse](docs/Model/SubTeamResponse.md) - [SubTemplateRole](docs/Model/SubTemplateRole.md) diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index 3e2c764a1..626120a2b 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -370,6 +370,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -398,6 +401,7 @@ $signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRe ->setFiles([ ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { @@ -467,6 +471,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") @@ -485,6 +492,7 @@ $signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Mod ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { @@ -557,6 +565,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -591,6 +602,7 @@ $signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRe EOD, true)) ->setFieldOptions($field_options) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { @@ -662,6 +674,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") ->setEmailAddress("jack@example.com") @@ -690,6 +705,7 @@ $signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequ ->setFiles([ ]) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { @@ -761,6 +777,9 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setType(true) ->setUpload(true); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") ->setName("George") @@ -779,6 +798,7 @@ $signature_request_edit_embedded_with_template_request = (new Dropbox\Sign\Model ->setSubject("Purchase Order") ->setTestMode(true) ->setSigningOptions($signing_options) + ->setSignerExperience($signer_experience) ->setSigners($signers); try { diff --git a/sdks/php/docs/Api/TemplateApi.md b/sdks/php/docs/Api/TemplateApi.md index d3850f71b..7123d41d7 100644 --- a/sdks/php/docs/Api/TemplateApi.md +++ b/sdks/php/docs/Api/TemplateApi.md @@ -111,6 +111,9 @@ $config->setUsername("YOUR_API_KEY"); $field_options = (new Dropbox\Sign\Model\SubFieldOptions()) ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) ->setName("Client") ->setOrder(0); @@ -182,6 +185,7 @@ $template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) ->setFiles([ ]) ->setFieldOptions($field_options) + ->setSignerExperience($signer_experience) ->setSignerRoles($signer_roles) ->setFormFieldsPerDocument($form_fields_per_document) ->setMergeFields($merge_fields); @@ -780,6 +784,9 @@ $config = Dropbox\Sign\Configuration::getDefaultConfiguration(); $config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); +$signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) + ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); + $form_fields_1 = (new Dropbox\Sign\Model\SubUpdateFormField()) ->setApiId("uniqueIdHere_1") ->setName("New name 1"); @@ -794,7 +801,6 @@ $form_fields = [ ]; $template_update_request = (new Dropbox\Sign\Model\TemplateUpdateRequest()) - ->setAllowFormView(false) ->setTitle("Test Title") ->setSubject("Test Subject") ->setMessage("Test Message") @@ -802,6 +808,7 @@ $template_update_request = (new Dropbox\Sign\Model\TemplateUpdateRequest()) "CC Role 1", "CC Role 2", ]) + ->setSignerExperience($signer_experience) ->setFormFields($form_fields); try { diff --git a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md index 247951d28..9ae85f6df 100644 --- a/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/php/docs/Model/BulkSendJobGetResponseSignatureRequests.md @@ -31,5 +31,6 @@ Name | Type | Description | Notes | `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```string``` | The id of the BulkSendJob. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md index c3af7257f..e6a1e94e6 100644 --- a/sdks/php/docs/Model/EmbeddedEditUrlRequest.md +++ b/sdks/php/docs/Model/EmbeddedEditUrlRequest.md @@ -7,7 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `allow_edit_ccs` | ```bool``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | | `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to false] | @@ -17,5 +16,6 @@ Name | Type | Description | Notes | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience. | [default to false] | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | | `test_mode` | ```bool``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to false] | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md index 289707f27..7ef50faa8 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | @@ -30,6 +29,7 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md index b41a8e311..d8f0e6bdb 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -21,5 +21,6 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md index 09b9795f1..65af8ee01 100644 --- a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | @@ -31,5 +30,6 @@ Name | Type | Description | Notes | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md index 3b9df4cac..e1141d91b 100644 --- a/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -21,5 +21,6 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestEditRequest.md b/sdks/php/docs/Model/SignatureRequestEditRequest.md index c108f36ff..d0c680ecc 100644 --- a/sdks/php/docs/Model/SignatureRequestEditRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `signers` | [```\Dropbox\Sign\Model\SubSignatureRequestSigner[]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | @@ -32,5 +31,6 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md index 072fdc080..0e457c5d3 100644 --- a/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditWithTemplateRequest.md @@ -22,5 +22,6 @@ Name | Type | Description | Notes | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestResponse.md b/sdks/php/docs/Model/SignatureRequestResponse.md index bb04b5d30..0b9701537 100644 --- a/sdks/php/docs/Model/SignatureRequestResponse.md +++ b/sdks/php/docs/Model/SignatureRequestResponse.md @@ -31,5 +31,6 @@ Name | Type | Description | Notes | `response_data` | [```\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```string``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendRequest.md b/sdks/php/docs/Model/SignatureRequestSendRequest.md index c117edd10..7a6dbb1f7 100644 --- a/sdks/php/docs/Model/SignatureRequestSendRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `grouped_signers` | [```\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `client_id` | ```string``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | @@ -33,5 +32,6 @@ Name | Type | Description | Notes | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md index cbfaeb338..5f16a0938 100644 --- a/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendWithTemplateRequest.md @@ -23,5 +23,6 @@ Name | Type | Description | Notes | `subject` | ```string``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSignerExperience.md b/sdks/php/docs/Model/SignatureRequestSignerExperience.md new file mode 100644 index 000000000..7ac28f108 --- /dev/null +++ b/sdks/php/docs/Model/SignatureRequestSignerExperience.md @@ -0,0 +1,11 @@ +# # SignatureRequestSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `form_view`*_required_ | ```string``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SubSignerExperience.md b/sdks/php/docs/Model/SubSignerExperience.md new file mode 100644 index 000000000..7baee01c7 --- /dev/null +++ b/sdks/php/docs/Model/SubSignerExperience.md @@ -0,0 +1,11 @@ +# # SubSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `form_view` | ```string``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + +[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md index 3b59a8cd9..160c72f44 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | | `editor_options` | [```\Dropbox\Sign\Model\SubEditorOptions```](SubEditorOptions.md) | | | @@ -32,5 +31,6 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateRequest.md b/sdks/php/docs/Model/TemplateCreateRequest.md index 9f0130234..ec8de4084 100644 --- a/sdks/php/docs/Model/TemplateCreateRequest.md +++ b/sdks/php/docs/Model/TemplateCreateRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request | | | `client_id` | ```string``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | @@ -25,5 +24,6 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index dfeace49a..1bd632c45 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -22,6 +22,6 @@ Name | Type | Description | Notes | `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments` | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateUpdateRequest.md b/sdks/php/docs/Model/TemplateUpdateRequest.md index bfca7b51d..997716ecb 100644 --- a/sdks/php/docs/Model/TemplateUpdateRequest.md +++ b/sdks/php/docs/Model/TemplateUpdateRequest.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `cc_roles` | ```string[]``` | The CC roles that must be assigned when using the template to send a signature request. | | -| `allow_form_view` | ```bool``` | The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. | | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `subject` | ```string``` | The new default template email subject. | | | `message` | ```string``` | The new default template email message. | | | `form_fields` | [```\Dropbox\Sign\Model\SubUpdateFormField[]```](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md index e9ae156b0..4d9b2c5c4 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,7 +12,6 @@ Name | Type | Description | Notes | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md index 6dd305754..095985eaa 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes | `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```\Dropbox\Sign\Model\SubAttachment[]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```string[]``` | The email addresses that should be CCed. | | | `client_id` | ```string``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | @@ -31,5 +30,6 @@ Name | Type | Description | Notes | `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `signer_experience` | [```\Dropbox\Sign\Model\SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php index f40d42b60..886511a80 100644 --- a/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php +++ b/sdks/php/src/Model/BulkSendJobGetResponseSignatureRequests.php @@ -82,6 +82,7 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]', 'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]', 'bulk_send_job_id' => 'string', + 'signer_experience' => '\Dropbox\Sign\Model\SignatureRequestSignerExperience', ]; /** @@ -117,6 +118,7 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'response_data' => null, 'signatures' => null, 'bulk_send_job_id' => null, + 'signer_experience' => null, ]; /** @@ -150,6 +152,7 @@ class BulkSendJobGetResponseSignatureRequests implements ModelInterface, ArrayAc 'response_data' => true, 'signatures' => false, 'bulk_send_job_id' => false, + 'signer_experience' => false, ]; /** @@ -255,6 +258,7 @@ public function isNullableSetToNull(string $property): bool 'response_data' => 'response_data', 'signatures' => 'signatures', 'bulk_send_job_id' => 'bulk_send_job_id', + 'signer_experience' => 'signer_experience', ]; /** @@ -288,6 +292,7 @@ public function isNullableSetToNull(string $property): bool 'response_data' => 'setResponseData', 'signatures' => 'setSignatures', 'bulk_send_job_id' => 'setBulkSendJobId', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -321,6 +326,7 @@ public function isNullableSetToNull(string $property): bool 'response_data' => 'getResponseData', 'signatures' => 'getSignatures', 'bulk_send_job_id' => 'getBulkSendJobId', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -404,6 +410,7 @@ public function __construct(?array $data = null) $this->setIfExists('response_data', $data ?? [], null); $this->setIfExists('signatures', $data ?? [], null); $this->setIfExists('bulk_send_job_id', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -1215,6 +1222,33 @@ public function setBulkSendJobId(?string $bulk_send_job_id) return $this; } + /** + * Gets signer_experience + * + * @return SignatureRequestSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SignatureRequestSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SignatureRequestSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/EmbeddedEditUrlRequest.php b/sdks/php/src/Model/EmbeddedEditUrlRequest.php index 4f5e5be71..a6859d89c 100644 --- a/sdks/php/src/Model/EmbeddedEditUrlRequest.php +++ b/sdks/php/src/Model/EmbeddedEditUrlRequest.php @@ -58,7 +58,6 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali */ protected static $openAPITypes = [ 'allow_edit_ccs' => 'bool', - 'allow_form_view' => 'bool', 'cc_roles' => 'string[]', 'editor_options' => '\Dropbox\Sign\Model\SubEditorOptions', 'force_signer_roles' => 'bool', @@ -68,6 +67,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali 'show_preview' => 'bool', 'show_progress_stepper' => 'bool', 'test_mode' => 'bool', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -79,7 +79,6 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali */ protected static $openAPIFormats = [ 'allow_edit_ccs' => null, - 'allow_form_view' => null, 'cc_roles' => null, 'editor_options' => null, 'force_signer_roles' => null, @@ -89,6 +88,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali 'show_preview' => null, 'show_progress_stepper' => null, 'test_mode' => null, + 'signer_experience' => null, ]; /** @@ -98,7 +98,6 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali */ protected static array $openAPINullables = [ 'allow_edit_ccs' => false, - 'allow_form_view' => false, 'cc_roles' => false, 'editor_options' => false, 'force_signer_roles' => false, @@ -108,6 +107,7 @@ class EmbeddedEditUrlRequest implements ModelInterface, ArrayAccess, JsonSeriali 'show_preview' => false, 'show_progress_stepper' => false, 'test_mode' => false, + 'signer_experience' => false, ]; /** @@ -189,7 +189,6 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'allow_edit_ccs' => 'allow_edit_ccs', - 'allow_form_view' => 'allow_form_view', 'cc_roles' => 'cc_roles', 'editor_options' => 'editor_options', 'force_signer_roles' => 'force_signer_roles', @@ -199,6 +198,7 @@ public function isNullableSetToNull(string $property): bool 'show_preview' => 'show_preview', 'show_progress_stepper' => 'show_progress_stepper', 'test_mode' => 'test_mode', + 'signer_experience' => 'signer_experience', ]; /** @@ -208,7 +208,6 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'allow_edit_ccs' => 'setAllowEditCcs', - 'allow_form_view' => 'setAllowFormView', 'cc_roles' => 'setCcRoles', 'editor_options' => 'setEditorOptions', 'force_signer_roles' => 'setForceSignerRoles', @@ -218,6 +217,7 @@ public function isNullableSetToNull(string $property): bool 'show_preview' => 'setShowPreview', 'show_progress_stepper' => 'setShowProgressStepper', 'test_mode' => 'setTestMode', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -227,7 +227,6 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'allow_edit_ccs' => 'getAllowEditCcs', - 'allow_form_view' => 'getAllowFormView', 'cc_roles' => 'getCcRoles', 'editor_options' => 'getEditorOptions', 'force_signer_roles' => 'getForceSignerRoles', @@ -237,6 +236,7 @@ public function isNullableSetToNull(string $property): bool 'show_preview' => 'getShowPreview', 'show_progress_stepper' => 'getShowProgressStepper', 'test_mode' => 'getTestMode', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -296,7 +296,6 @@ public function getModelName() public function __construct(?array $data = null) { $this->setIfExists('allow_edit_ccs', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('editor_options', $data ?? [], null); $this->setIfExists('force_signer_roles', $data ?? [], false); @@ -306,6 +305,7 @@ public function __construct(?array $data = null) $this->setIfExists('show_preview', $data ?? [], false); $this->setIfExists('show_progress_stepper', $data ?? [], true); $this->setIfExists('test_mode', $data ?? [], false); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -392,33 +392,6 @@ public function setAllowEditCcs(?bool $allow_edit_ccs) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets cc_roles * @@ -662,6 +635,33 @@ public function setTestMode(?bool $test_mode) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php index 9d1211182..0b859ca62 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php @@ -64,7 +64,6 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', - 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -82,6 +81,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => 'string', 'use_text_tags' => 'bool', 'populate_auto_fill_fields' => 'bool', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', 'expires_at' => 'int', ]; @@ -99,7 +99,6 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'signers' => null, 'grouped_signers' => null, 'allow_decline' => null, - 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -117,6 +116,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => null, 'use_text_tags' => null, 'populate_auto_fill_fields' => null, + 'signer_experience' => null, 'expires_at' => null, ]; @@ -132,7 +132,6 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'signers' => false, 'grouped_signers' => false, 'allow_decline' => false, - 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -150,6 +149,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'title' => false, 'use_text_tags' => false, 'populate_auto_fill_fields' => false, + 'signer_experience' => false, 'expires_at' => true, ]; @@ -237,7 +237,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'signers', 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', - 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -255,6 +254,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'title', 'use_text_tags' => 'use_text_tags', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', + 'signer_experience' => 'signer_experience', 'expires_at' => 'expires_at', ]; @@ -270,7 +270,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'setSigners', 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', - 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -288,6 +287,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', + 'signer_experience' => 'setSignerExperience', 'expires_at' => 'setExpiresAt', ]; @@ -303,7 +303,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'getSigners', 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', - 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -321,6 +320,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', + 'signer_experience' => 'getSignerExperience', 'expires_at' => 'getExpiresAt', ]; @@ -386,7 +386,6 @@ public function __construct(?array $data = null) $this->setIfExists('signers', $data ?? [], null); $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -404,6 +403,7 @@ public function __construct(?array $data = null) $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_text_tags', $data ?? [], false); $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); + $this->setIfExists('signer_experience', $data ?? [], null); $this->setIfExists('expires_at', $data ?? [], null); } @@ -643,33 +643,6 @@ public function setAllowDecline(?bool $allow_decline) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets allow_reassign * @@ -1142,6 +1115,33 @@ public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Gets expires_at * diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php index b90396231..85d62c816 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedWithTemplateRequest.php @@ -73,6 +73,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'test_mode' => 'bool', 'title' => 'string', 'populate_auto_fill_fields' => 'bool', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -98,6 +99,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'test_mode' => null, 'title' => null, 'populate_auto_fill_fields' => null, + 'signer_experience' => null, ]; /** @@ -121,6 +123,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest implements ModelInterfac 'test_mode' => false, 'title' => false, 'populate_auto_fill_fields' => false, + 'signer_experience' => false, ]; /** @@ -216,6 +219,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', + 'signer_experience' => 'signer_experience', ]; /** @@ -239,6 +243,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -262,6 +267,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -335,6 +341,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -835,6 +842,33 @@ public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php index 3a42283ba..8a52e7341 100644 --- a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php @@ -64,7 +64,6 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', - 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -83,6 +82,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'use_text_tags' => 'bool', 'populate_auto_fill_fields' => 'bool', 'expires_at' => 'int', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -99,7 +99,6 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'signers' => null, 'grouped_signers' => null, 'allow_decline' => null, - 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -118,6 +117,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'use_text_tags' => null, 'populate_auto_fill_fields' => null, 'expires_at' => null, + 'signer_experience' => null, ]; /** @@ -132,7 +132,6 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'signers' => false, 'grouped_signers' => false, 'allow_decline' => false, - 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -151,6 +150,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'use_text_tags' => false, 'populate_auto_fill_fields' => false, 'expires_at' => true, + 'signer_experience' => false, ]; /** @@ -237,7 +237,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'signers', 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', - 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -256,6 +255,7 @@ public function isNullableSetToNull(string $property): bool 'use_text_tags' => 'use_text_tags', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', 'expires_at' => 'expires_at', + 'signer_experience' => 'signer_experience', ]; /** @@ -270,7 +270,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'setSigners', 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', - 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -289,6 +288,7 @@ public function isNullableSetToNull(string $property): bool 'use_text_tags' => 'setUseTextTags', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', 'expires_at' => 'setExpiresAt', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -303,7 +303,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'getSigners', 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', - 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -322,6 +321,7 @@ public function isNullableSetToNull(string $property): bool 'use_text_tags' => 'getUseTextTags', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', 'expires_at' => 'getExpiresAt', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -386,7 +386,6 @@ public function __construct(?array $data = null) $this->setIfExists('signers', $data ?? [], null); $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -405,6 +404,7 @@ public function __construct(?array $data = null) $this->setIfExists('use_text_tags', $data ?? [], false); $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -643,33 +643,6 @@ public function setAllowDecline(?bool $allow_decline) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets allow_reassign * @@ -1176,6 +1149,33 @@ public function setExpiresAt(?int $expires_at) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php index 05fbee5e9..f1d95b1eb 100644 --- a/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditEmbeddedWithTemplateRequest.php @@ -73,6 +73,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => 'bool', 'title' => 'string', 'populate_auto_fill_fields' => 'bool', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -98,6 +99,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => null, 'title' => null, 'populate_auto_fill_fields' => null, + 'signer_experience' => null, ]; /** @@ -121,6 +123,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest implements ModelInterface, 'test_mode' => false, 'title' => false, 'populate_auto_fill_fields' => false, + 'signer_experience' => false, ]; /** @@ -216,6 +219,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', + 'signer_experience' => 'signer_experience', ]; /** @@ -239,6 +243,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -262,6 +267,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -335,6 +341,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -835,6 +842,33 @@ public function setPopulateAutoFillFields(?bool $populate_auto_fill_fields) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestEditRequest.php b/sdks/php/src/Model/SignatureRequestEditRequest.php index 7e4fe37d3..a84be8b26 100644 --- a/sdks/php/src/Model/SignatureRequestEditRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditRequest.php @@ -63,7 +63,6 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'signers' => '\Dropbox\Sign\Model\SubSignatureRequestSigner[]', 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', - 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -84,6 +83,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => 'string', 'use_text_tags' => 'bool', 'expires_at' => 'int', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -99,7 +99,6 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'signers' => null, 'grouped_signers' => null, 'allow_decline' => null, - 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -120,6 +119,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => null, 'use_text_tags' => null, 'expires_at' => null, + 'signer_experience' => null, ]; /** @@ -133,7 +133,6 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'signers' => false, 'grouped_signers' => false, 'allow_decline' => false, - 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -154,6 +153,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => false, 'use_text_tags' => false, 'expires_at' => true, + 'signer_experience' => false, ]; /** @@ -239,7 +239,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'signers', 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', - 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -260,6 +259,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'title', 'use_text_tags' => 'use_text_tags', 'expires_at' => 'expires_at', + 'signer_experience' => 'signer_experience', ]; /** @@ -273,7 +273,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'setSigners', 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', - 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -294,6 +293,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', 'expires_at' => 'setExpiresAt', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -307,7 +307,6 @@ public function isNullableSetToNull(string $property): bool 'signers' => 'getSigners', 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', - 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -328,6 +327,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', 'expires_at' => 'getExpiresAt', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -391,7 +391,6 @@ public function __construct(?array $data = null) $this->setIfExists('signers', $data ?? [], null); $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -412,6 +411,7 @@ public function __construct(?array $data = null) $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_text_tags', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -620,33 +620,6 @@ public function setAllowDecline(?bool $allow_decline) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets allow_reassign * @@ -1207,6 +1180,33 @@ public function setExpiresAt(?int $expires_at) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php index b27cec8ee..9d56aba0d 100644 --- a/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditWithTemplateRequest.php @@ -75,6 +75,7 @@ class SignatureRequestEditWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -101,6 +102,7 @@ class SignatureRequestEditWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => null, 'test_mode' => null, 'title' => null, + 'signer_experience' => null, ]; /** @@ -125,6 +127,7 @@ class SignatureRequestEditWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => false, 'test_mode' => false, 'title' => false, + 'signer_experience' => false, ]; /** @@ -221,6 +224,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', + 'signer_experience' => 'signer_experience', ]; /** @@ -245,6 +249,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -269,6 +274,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -343,6 +349,7 @@ public function __construct(?array $data = null) $this->setIfExists('subject', $data ?? [], null); $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -867,6 +874,33 @@ public function setTitle(?string $title) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestResponse.php b/sdks/php/src/Model/SignatureRequestResponse.php index 6993121e8..47544570b 100644 --- a/sdks/php/src/Model/SignatureRequestResponse.php +++ b/sdks/php/src/Model/SignatureRequestResponse.php @@ -83,6 +83,7 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria 'response_data' => '\Dropbox\Sign\Model\SignatureRequestResponseDataBase[]', 'signatures' => '\Dropbox\Sign\Model\SignatureRequestResponseSignatures[]', 'bulk_send_job_id' => 'string', + 'signer_experience' => '\Dropbox\Sign\Model\SignatureRequestSignerExperience', ]; /** @@ -118,6 +119,7 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria 'response_data' => null, 'signatures' => null, 'bulk_send_job_id' => null, + 'signer_experience' => null, ]; /** @@ -151,6 +153,7 @@ class SignatureRequestResponse implements ModelInterface, ArrayAccess, JsonSeria 'response_data' => true, 'signatures' => false, 'bulk_send_job_id' => true, + 'signer_experience' => false, ]; /** @@ -256,6 +259,7 @@ public function isNullableSetToNull(string $property): bool 'response_data' => 'response_data', 'signatures' => 'signatures', 'bulk_send_job_id' => 'bulk_send_job_id', + 'signer_experience' => 'signer_experience', ]; /** @@ -289,6 +293,7 @@ public function isNullableSetToNull(string $property): bool 'response_data' => 'setResponseData', 'signatures' => 'setSignatures', 'bulk_send_job_id' => 'setBulkSendJobId', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -322,6 +327,7 @@ public function isNullableSetToNull(string $property): bool 'response_data' => 'getResponseData', 'signatures' => 'getSignatures', 'bulk_send_job_id' => 'getBulkSendJobId', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -405,6 +411,7 @@ public function __construct(?array $data = null) $this->setIfExists('response_data', $data ?? [], null); $this->setIfExists('signatures', $data ?? [], null); $this->setIfExists('bulk_send_job_id', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -1223,6 +1230,33 @@ public function setBulkSendJobId(?string $bulk_send_job_id) return $this; } + /** + * Gets signer_experience + * + * @return SignatureRequestSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SignatureRequestSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SignatureRequestSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestSendRequest.php b/sdks/php/src/Model/SignatureRequestSendRequest.php index c1392ed35..0cc66cb69 100644 --- a/sdks/php/src/Model/SignatureRequestSendRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendRequest.php @@ -64,7 +64,6 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'grouped_signers' => '\Dropbox\Sign\Model\SubSignatureRequestGroupedSigners[]', 'allow_decline' => 'bool', 'allow_reassign' => 'bool', - 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', 'client_id' => 'string', @@ -85,6 +84,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => 'string', 'use_text_tags' => 'bool', 'expires_at' => 'int', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -101,7 +101,6 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'grouped_signers' => null, 'allow_decline' => null, 'allow_reassign' => null, - 'allow_form_view' => null, 'attachments' => null, 'cc_email_addresses' => 'email', 'client_id' => null, @@ -122,6 +121,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => null, 'use_text_tags' => null, 'expires_at' => null, + 'signer_experience' => null, ]; /** @@ -136,7 +136,6 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'grouped_signers' => false, 'allow_decline' => false, 'allow_reassign' => false, - 'allow_form_view' => false, 'attachments' => false, 'cc_email_addresses' => false, 'client_id' => false, @@ -157,6 +156,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'title' => false, 'use_text_tags' => false, 'expires_at' => true, + 'signer_experience' => false, ]; /** @@ -243,7 +243,6 @@ public function isNullableSetToNull(string $property): bool 'grouped_signers' => 'grouped_signers', 'allow_decline' => 'allow_decline', 'allow_reassign' => 'allow_reassign', - 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', 'client_id' => 'client_id', @@ -264,6 +263,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'title', 'use_text_tags' => 'use_text_tags', 'expires_at' => 'expires_at', + 'signer_experience' => 'signer_experience', ]; /** @@ -278,7 +278,6 @@ public function isNullableSetToNull(string $property): bool 'grouped_signers' => 'setGroupedSigners', 'allow_decline' => 'setAllowDecline', 'allow_reassign' => 'setAllowReassign', - 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', 'client_id' => 'setClientId', @@ -299,6 +298,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', 'expires_at' => 'setExpiresAt', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -313,7 +313,6 @@ public function isNullableSetToNull(string $property): bool 'grouped_signers' => 'getGroupedSigners', 'allow_decline' => 'getAllowDecline', 'allow_reassign' => 'getAllowReassign', - 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', 'client_id' => 'getClientId', @@ -334,6 +333,7 @@ public function isNullableSetToNull(string $property): bool 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', 'expires_at' => 'getExpiresAt', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -398,7 +398,6 @@ public function __construct(?array $data = null) $this->setIfExists('grouped_signers', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); @@ -419,6 +418,7 @@ public function __construct(?array $data = null) $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_text_tags', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -654,33 +654,6 @@ public function setAllowReassign(?bool $allow_reassign) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets attachments * @@ -1243,6 +1216,33 @@ public function setExpiresAt(?int $expires_at) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php index a353109aa..1762d285d 100644 --- a/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendWithTemplateRequest.php @@ -76,6 +76,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => 'string', 'test_mode' => 'bool', 'title' => 'string', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -103,6 +104,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => null, 'test_mode' => null, 'title' => null, + 'signer_experience' => null, ]; /** @@ -128,6 +130,7 @@ class SignatureRequestSendWithTemplateRequest implements ModelInterface, ArrayAc 'subject' => false, 'test_mode' => false, 'title' => false, + 'signer_experience' => false, ]; /** @@ -225,6 +228,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'subject', 'test_mode' => 'test_mode', 'title' => 'title', + 'signer_experience' => 'signer_experience', ]; /** @@ -250,6 +254,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'setSubject', 'test_mode' => 'setTestMode', 'title' => 'setTitle', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -275,6 +280,7 @@ public function isNullableSetToNull(string $property): bool 'subject' => 'getSubject', 'test_mode' => 'getTestMode', 'title' => 'getTitle', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -350,6 +356,7 @@ public function __construct(?array $data = null) $this->setIfExists('subject', $data ?? [], null); $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -903,6 +910,33 @@ public function setTitle(?string $title) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/SignatureRequestSignerExperience.php b/sdks/php/src/Model/SignatureRequestSignerExperience.php new file mode 100644 index 000000000..a6d40e6a4 --- /dev/null +++ b/sdks/php/src/Model/SignatureRequestSignerExperience.php @@ -0,0 +1,456 @@ + + */ +class SignatureRequestSignerExperience implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'SignatureRequestSignerExperience'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'form_view' => 'string', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'form_view' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'form_view' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'form_view' => 'form_view', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'form_view' => 'setFormView', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'form_view' => 'getFormView', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + public const FORM_VIEW_DISABLED = 'disabled'; + public const FORM_VIEW_ENABLED = 'enabled'; + public const FORM_VIEW_ENABLED_BY_DEFAULT = 'enabled_by_default'; + public const FORM_VIEW_FORCED = 'forced'; + + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getFormViewAllowableValues() + { + return [ + self::FORM_VIEW_DISABLED, + self::FORM_VIEW_ENABLED, + self::FORM_VIEW_ENABLED_BY_DEFAULT, + self::FORM_VIEW_FORCED, + ]; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[]|null $data Associated array of property values + * initializing the model + */ + public function __construct(?array $data = null) + { + $this->setIfExists('form_view', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): SignatureRequestSignerExperience + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): SignatureRequestSignerExperience + { + /** @var SignatureRequestSignerExperience */ + return ObjectSerializer::deserialize( + $data, + SignatureRequestSignerExperience::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + if ($this->container['form_view'] === null) { + $invalidProperties[] = "'form_view' can't be null"; + } + $allowedValues = $this->getFormViewAllowableValues(); + if (!is_null($this->container['form_view']) && !in_array($this->container['form_view'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'form_view', must be one of '%s'", + $this->container['form_view'], + implode("', '", $allowedValues) + ); + } + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets form_view + * + * @return string + */ + public function getFormView() + { + return $this->container['form_view']; + } + + /** + * Sets form_view + * + * @param string $form_view Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + * + * @return self + */ + public function setFormView(string $form_view) + { + if (is_null($form_view)) { + throw new InvalidArgumentException('non-nullable form_view cannot be null'); + } + $allowedValues = $this->getFormViewAllowableValues(); + if (!in_array($form_view, $allowedValues, true)) { + throw new InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'form_view', must be one of '%s'", + $form_view, + implode("', '", $allowedValues) + ) + ); + } + $this->container['form_view'] = $form_view; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/SubSignerExperience.php b/sdks/php/src/Model/SubSignerExperience.php new file mode 100644 index 000000000..1d2ff65f5 --- /dev/null +++ b/sdks/php/src/Model/SubSignerExperience.php @@ -0,0 +1,453 @@ + + */ +class SubSignerExperience implements ModelInterface, ArrayAccess, JsonSerializable +{ + public const DISCRIMINATOR = null; + + /** + * The original name of the model. + * + * @var string + */ + protected static $openAPIModelName = 'SubSignerExperience'; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @var string[] + */ + protected static $openAPITypes = [ + 'form_view' => 'string', + ]; + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @var string[] + * @phpstan-var array + * @psalm-var array + */ + protected static $openAPIFormats = [ + 'form_view' => null, + ]; + + /** + * Array of nullable properties. Used for (de)serialization + * + * @var bool[] + */ + protected static array $openAPINullables = [ + 'form_view' => false, + ]; + + /** + * If a nullable field gets set to null, insert it here + * + * @var bool[] + */ + protected array $openAPINullablesSetToNull = []; + + /** + * Array of property to type mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPITypes() + { + return self::$openAPITypes; + } + + /** + * Array of property to format mappings. Used for (de)serialization + * + * @return array + */ + public static function openAPIFormats() + { + return self::$openAPIFormats; + } + + /** + * Array of nullable properties + */ + protected static function openAPINullables(): array + { + return self::$openAPINullables; + } + + /** + * Array of nullable field names deliberately set to null + * + * @return bool[] + */ + private function getOpenAPINullablesSetToNull(): array + { + return $this->openAPINullablesSetToNull; + } + + /** + * Setter - Array of nullable field names deliberately set to null + * + * @param bool[] $openAPINullablesSetToNull + */ + private function setOpenAPINullablesSetToNull(array $openAPINullablesSetToNull): void + { + $this->openAPINullablesSetToNull = $openAPINullablesSetToNull; + } + + /** + * Checks if a property is nullable + */ + public static function isNullable(string $property): bool + { + return self::openAPINullables()[$property] ?? false; + } + + /** + * Checks if a nullable property is set to null. + */ + public function isNullableSetToNull(string $property): bool + { + return in_array($property, $this->getOpenAPINullablesSetToNull(), true); + } + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @var string[] + */ + protected static $attributeMap = [ + 'form_view' => 'form_view', + ]; + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @var string[] + */ + protected static $setters = [ + 'form_view' => 'setFormView', + ]; + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @var string[] + */ + protected static $getters = [ + 'form_view' => 'getFormView', + ]; + + /** + * Array of attributes where the key is the local name, + * and the value is the original name + * + * @return array + */ + public static function attributeMap() + { + return self::$attributeMap; + } + + /** + * Array of attributes to setter functions (for deserialization of responses) + * + * @return array + */ + public static function setters() + { + return self::$setters; + } + + /** + * Array of attributes to getter functions (for serialization of requests) + * + * @return array + */ + public static function getters() + { + return self::$getters; + } + + /** + * The original name of the model. + * + * @return string + */ + public function getModelName() + { + return self::$openAPIModelName; + } + + public const FORM_VIEW_DISABLED = 'disabled'; + public const FORM_VIEW_ENABLED = 'enabled'; + public const FORM_VIEW_ENABLED_BY_DEFAULT = 'enabled_by_default'; + public const FORM_VIEW_FORCED = 'forced'; + + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getFormViewAllowableValues() + { + return [ + self::FORM_VIEW_DISABLED, + self::FORM_VIEW_ENABLED, + self::FORM_VIEW_ENABLED_BY_DEFAULT, + self::FORM_VIEW_FORCED, + ]; + } + + /** + * Associative array for storing property values + * + * @var mixed[] + */ + protected $container = []; + + /** + * Constructor + * + * @param mixed[]|null $data Associated array of property values + * initializing the model + */ + public function __construct(?array $data = null) + { + $this->setIfExists('form_view', $data ?? [], null); + } + + /** + * @deprecated use ::init() + */ + public static function fromArray(array $data): SubSignerExperience + { + return self::init($data); + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + */ + public static function init(array $data): SubSignerExperience + { + /** @var SubSignerExperience */ + return ObjectSerializer::deserialize( + $data, + SubSignerExperience::class, + ); + } + + /** + * Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName + * is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the + * $this->openAPINullablesSetToNull array + * + * @param string|int|object|array|mixed $defaultValue + */ + private function setIfExists(string $variableName, array $fields, $defaultValue): void + { + if (self::isNullable($variableName) && array_key_exists($variableName, $fields) && is_null($fields[$variableName])) { + $this->openAPINullablesSetToNull[] = $variableName; + } + + $this->container[$variableName] = $fields[$variableName] ?? $defaultValue; + } + + /** + * Show all the invalid properties with reasons. + * + * @return array invalid properties with reasons + */ + public function listInvalidProperties() + { + $invalidProperties = []; + + $allowedValues = $this->getFormViewAllowableValues(); + if (!is_null($this->container['form_view']) && !in_array($this->container['form_view'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'form_view', must be one of '%s'", + $this->container['form_view'], + implode("', '", $allowedValues) + ); + } + + return $invalidProperties; + } + + /** + * Validate all the properties in the model + * return true if all passed + * + * @return bool True if all properties are valid + */ + public function valid() + { + return count($this->listInvalidProperties()) === 0; + } + + /** + * Gets form_view + * + * @return string|null + */ + public function getFormView() + { + return $this->container['form_view']; + } + + /** + * Sets form_view + * + * @param string|null $form_view Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + * + * @return self + */ + public function setFormView(?string $form_view) + { + if (is_null($form_view)) { + throw new InvalidArgumentException('non-nullable form_view cannot be null'); + } + $allowedValues = $this->getFormViewAllowableValues(); + if (!in_array($form_view, $allowedValues, true)) { + throw new InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'form_view', must be one of '%s'", + $form_view, + implode("', '", $allowedValues) + ) + ); + } + $this->container['form_view'] = $form_view; + + return $this; + } + + /** + * Returns true if offset exists. False otherwise. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetExists($offset): bool + { + return isset($this->container[$offset]); + } + + /** + * Gets offset. + * + * @param int $offset Offset + * + * @return mixed|null + */ + #[ReturnTypeWillChange] + public function offsetGet($offset) + { + return $this->container[$offset] ?? null; + } + + /** + * Sets value based on offset. + * + * @param int|null $offset Offset + * @param mixed $value Value to be set + */ + #[ReturnTypeWillChange] + public function offsetSet($offset, $value): void + { + if (is_null($offset)) { + $this->container[] = $value; + } else { + $this->container[$offset] = $value; + } + } + + /** + * Unsets offset. + * + * @param int $offset Offset + */ + #[ReturnTypeWillChange] + public function offsetUnset($offset): void + { + unset($this->container[$offset]); + } + + /** + * Serializes the object to a value that can be serialized natively by json_encode(). + * @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php + * + * @return mixed returns data which can be serialized by json_encode(), which is a value + * of any type other than a resource + */ + #[ReturnTypeWillChange] + public function jsonSerialize() + { + return ObjectSerializer::sanitizeForSerialization($this); + } + + /** + * Gets the string presentation of the object + * + * @return string + */ + public function __toString() + { + return json_encode( + ObjectSerializer::sanitizeForSerialization($this), + JSON_UNESCAPED_SLASHES + ); + } + + /** + * Gets a header-safe presentation of the object + * + * @return string + */ + public function toHeaderValue() + { + return json_encode(ObjectSerializer::sanitizeForSerialization($this)); + } +} diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php index 95c75c090..5f72a8ab5 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php @@ -63,7 +63,6 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'file_urls' => 'string[]', 'allow_ccs' => 'bool', 'allow_reassign' => 'bool', - 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_roles' => 'string[]', 'editor_options' => '\Dropbox\Sign\Model\SubEditorOptions', @@ -84,6 +83,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'test_mode' => 'bool', 'title' => 'string', 'use_preexisting_fields' => 'bool', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -99,7 +99,6 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'file_urls' => null, 'allow_ccs' => null, 'allow_reassign' => null, - 'allow_form_view' => null, 'attachments' => null, 'cc_roles' => null, 'editor_options' => null, @@ -120,6 +119,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'test_mode' => null, 'title' => null, 'use_preexisting_fields' => null, + 'signer_experience' => null, ]; /** @@ -133,7 +133,6 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'file_urls' => false, 'allow_ccs' => false, 'allow_reassign' => false, - 'allow_form_view' => false, 'attachments' => false, 'cc_roles' => false, 'editor_options' => false, @@ -154,6 +153,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'test_mode' => false, 'title' => false, 'use_preexisting_fields' => false, + 'signer_experience' => false, ]; /** @@ -239,7 +239,6 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'file_urls', 'allow_ccs' => 'allow_ccs', 'allow_reassign' => 'allow_reassign', - 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_roles' => 'cc_roles', 'editor_options' => 'editor_options', @@ -260,6 +259,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_preexisting_fields' => 'use_preexisting_fields', + 'signer_experience' => 'signer_experience', ]; /** @@ -273,7 +273,6 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'setFileUrls', 'allow_ccs' => 'setAllowCcs', 'allow_reassign' => 'setAllowReassign', - 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_roles' => 'setCcRoles', 'editor_options' => 'setEditorOptions', @@ -294,6 +293,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_preexisting_fields' => 'setUsePreexistingFields', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -307,7 +307,6 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'getFileUrls', 'allow_ccs' => 'getAllowCcs', 'allow_reassign' => 'getAllowReassign', - 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_roles' => 'getCcRoles', 'editor_options' => 'getEditorOptions', @@ -328,6 +327,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_preexisting_fields' => 'getUsePreexistingFields', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -391,7 +391,6 @@ public function __construct(?array $data = null) $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_ccs', $data ?? [], true); $this->setIfExists('allow_reassign', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('editor_options', $data ?? [], null); @@ -412,6 +411,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_preexisting_fields', $data ?? [], false); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -619,33 +619,6 @@ public function setAllowReassign(?bool $allow_reassign) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets attachments * @@ -1195,6 +1168,33 @@ public function setUsePreexistingFields(?bool $use_preexisting_fields) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateCreateRequest.php b/sdks/php/src/Model/TemplateCreateRequest.php index 4fe0fc0e5..7e590ecaf 100644 --- a/sdks/php/src/Model/TemplateCreateRequest.php +++ b/sdks/php/src/Model/TemplateCreateRequest.php @@ -63,7 +63,6 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', 'allow_reassign' => 'bool', - 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_roles' => 'string[]', 'client_id' => 'string', @@ -77,6 +76,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'test_mode' => 'bool', 'title' => 'string', 'use_preexisting_fields' => 'bool', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -92,7 +92,6 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'files' => 'binary', 'file_urls' => null, 'allow_reassign' => null, - 'allow_form_view' => null, 'attachments' => null, 'cc_roles' => null, 'client_id' => null, @@ -106,6 +105,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'test_mode' => null, 'title' => null, 'use_preexisting_fields' => null, + 'signer_experience' => null, ]; /** @@ -119,7 +119,6 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'files' => false, 'file_urls' => false, 'allow_reassign' => false, - 'allow_form_view' => false, 'attachments' => false, 'cc_roles' => false, 'client_id' => false, @@ -133,6 +132,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'test_mode' => false, 'title' => false, 'use_preexisting_fields' => false, + 'signer_experience' => false, ]; /** @@ -218,7 +218,6 @@ public function isNullableSetToNull(string $property): bool 'files' => 'files', 'file_urls' => 'file_urls', 'allow_reassign' => 'allow_reassign', - 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_roles' => 'cc_roles', 'client_id' => 'client_id', @@ -232,6 +231,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_preexisting_fields' => 'use_preexisting_fields', + 'signer_experience' => 'signer_experience', ]; /** @@ -245,7 +245,6 @@ public function isNullableSetToNull(string $property): bool 'files' => 'setFiles', 'file_urls' => 'setFileUrls', 'allow_reassign' => 'setAllowReassign', - 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_roles' => 'setCcRoles', 'client_id' => 'setClientId', @@ -259,6 +258,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_preexisting_fields' => 'setUsePreexistingFields', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -272,7 +272,6 @@ public function isNullableSetToNull(string $property): bool 'files' => 'getFiles', 'file_urls' => 'getFileUrls', 'allow_reassign' => 'getAllowReassign', - 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_roles' => 'getCcRoles', 'client_id' => 'getClientId', @@ -286,6 +285,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_preexisting_fields' => 'getUsePreexistingFields', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -349,7 +349,6 @@ public function __construct(?array $data = null) $this->setIfExists('files', $data ?? [], null); $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_reassign', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); @@ -363,6 +362,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_preexisting_fields', $data ?? [], false); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -573,33 +573,6 @@ public function setAllowReassign(?bool $allow_reassign) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets attachments * @@ -960,6 +933,33 @@ public function setUsePreexistingFields(?bool $use_preexisting_fields) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 6f2d94bbc..a987f6671 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -74,7 +74,7 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', - 'allow_form_view' => 'bool', + 'signer_experience' => '\Dropbox\Sign\Model\SignatureRequestSignerExperience', ]; /** @@ -101,7 +101,7 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'named_form_fields' => null, 'accounts' => null, 'attachments' => null, - 'allow_form_view' => null, + 'signer_experience' => null, ]; /** @@ -126,7 +126,7 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'named_form_fields' => true, 'accounts' => false, 'attachments' => false, - 'allow_form_view' => false, + 'signer_experience' => false, ]; /** @@ -223,7 +223,7 @@ public function isNullableSetToNull(string $property): bool 'named_form_fields' => 'named_form_fields', 'accounts' => 'accounts', 'attachments' => 'attachments', - 'allow_form_view' => 'allow_form_view', + 'signer_experience' => 'signer_experience', ]; /** @@ -248,7 +248,7 @@ public function isNullableSetToNull(string $property): bool 'named_form_fields' => 'setNamedFormFields', 'accounts' => 'setAccounts', 'attachments' => 'setAttachments', - 'allow_form_view' => 'setAllowFormView', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -273,7 +273,7 @@ public function isNullableSetToNull(string $property): bool 'named_form_fields' => 'getNamedFormFields', 'accounts' => 'getAccounts', 'attachments' => 'getAttachments', - 'allow_form_view' => 'getAllowFormView', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -348,7 +348,7 @@ public function __construct(?array $data = null) $this->setIfExists('named_form_fields', $data ?? [], null); $this->setIfExists('accounts', $data ?? [], null); $this->setIfExists('attachments', $data ?? [], null); - $this->setIfExists('allow_form_view', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -866,28 +866,28 @@ public function setAttachments(?array $attachments) } /** - * Gets allow_form_view + * Gets signer_experience * - * @return bool|null + * @return SignatureRequestSignerExperience|null */ - public function getAllowFormView() + public function getSignerExperience() { - return $this->container['allow_form_view']; + return $this->container['signer_experience']; } /** - * Sets allow_form_view + * Sets signer_experience * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. + * @param SignatureRequestSignerExperience|null $signer_experience signer_experience * * @return self */ - public function setAllowFormView(?bool $allow_form_view) + public function setSignerExperience(?SignatureRequestSignerExperience $signer_experience) { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); } - $this->container['allow_form_view'] = $allow_form_view; + $this->container['signer_experience'] = $signer_experience; return $this; } diff --git a/sdks/php/src/Model/TemplateUpdateRequest.php b/sdks/php/src/Model/TemplateUpdateRequest.php index 4814f540f..d2e6eb0d9 100644 --- a/sdks/php/src/Model/TemplateUpdateRequest.php +++ b/sdks/php/src/Model/TemplateUpdateRequest.php @@ -58,11 +58,11 @@ class TemplateUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializ */ protected static $openAPITypes = [ 'cc_roles' => 'string[]', - 'allow_form_view' => 'bool', 'title' => 'string', 'subject' => 'string', 'message' => 'string', 'form_fields' => '\Dropbox\Sign\Model\SubUpdateFormField[]', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -74,11 +74,11 @@ class TemplateUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializ */ protected static $openAPIFormats = [ 'cc_roles' => null, - 'allow_form_view' => null, 'title' => null, 'subject' => null, 'message' => null, 'form_fields' => null, + 'signer_experience' => null, ]; /** @@ -88,11 +88,11 @@ class TemplateUpdateRequest implements ModelInterface, ArrayAccess, JsonSerializ */ protected static array $openAPINullables = [ 'cc_roles' => false, - 'allow_form_view' => false, 'title' => false, 'subject' => false, 'message' => false, 'form_fields' => false, + 'signer_experience' => false, ]; /** @@ -174,11 +174,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'cc_roles' => 'cc_roles', - 'allow_form_view' => 'allow_form_view', 'title' => 'title', 'subject' => 'subject', 'message' => 'message', 'form_fields' => 'form_fields', + 'signer_experience' => 'signer_experience', ]; /** @@ -188,11 +188,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'cc_roles' => 'setCcRoles', - 'allow_form_view' => 'setAllowFormView', 'title' => 'setTitle', 'subject' => 'setSubject', 'message' => 'setMessage', 'form_fields' => 'setFormFields', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -202,11 +202,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'cc_roles' => 'getCcRoles', - 'allow_form_view' => 'getAllowFormView', 'title' => 'getTitle', 'subject' => 'getSubject', 'message' => 'getMessage', 'form_fields' => 'getFormFields', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -266,11 +266,11 @@ public function getModelName() public function __construct(?array $data = null) { $this->setIfExists('cc_roles', $data ?? [], null); - $this->setIfExists('allow_form_view', $data ?? [], null); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('subject', $data ?? [], null); $this->setIfExists('message', $data ?? [], null); $this->setIfExists('form_fields', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -367,33 +367,6 @@ public function setCcRoles(?array $cc_roles) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets title * @@ -510,6 +483,33 @@ public function setFormFields(?array $form_fields) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php index 399df6cbb..fa78f95e6 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php @@ -65,7 +65,6 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'file_urls' => 'string[]', 'allow_ccs' => 'bool', 'allow_decline' => 'bool', - 'allow_form_view' => 'bool', 'allow_reassign' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', @@ -112,7 +111,6 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'file_urls' => null, 'allow_ccs' => null, 'allow_decline' => null, - 'allow_form_view' => null, 'allow_reassign' => null, 'attachments' => null, 'cc_email_addresses' => 'email', @@ -157,7 +155,6 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'file_urls' => false, 'allow_ccs' => false, 'allow_decline' => false, - 'allow_form_view' => false, 'allow_reassign' => false, 'attachments' => false, 'cc_email_addresses' => false, @@ -274,7 +271,6 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'file_urls', 'allow_ccs' => 'allow_ccs', 'allow_decline' => 'allow_decline', - 'allow_form_view' => 'allow_form_view', 'allow_reassign' => 'allow_reassign', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', @@ -319,7 +315,6 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'setFileUrls', 'allow_ccs' => 'setAllowCcs', 'allow_decline' => 'setAllowDecline', - 'allow_form_view' => 'setAllowFormView', 'allow_reassign' => 'setAllowReassign', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', @@ -364,7 +359,6 @@ public function isNullableSetToNull(string $property): bool 'file_urls' => 'getFileUrls', 'allow_ccs' => 'getAllowCcs', 'allow_decline' => 'getAllowDecline', - 'allow_form_view' => 'getAllowFormView', 'allow_reassign' => 'getAllowReassign', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', @@ -475,7 +469,6 @@ public function __construct(?array $data = null) $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_ccs', $data ?? [], true); $this->setIfExists('allow_decline', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('allow_reassign', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); @@ -752,33 +745,6 @@ public function setAllowDecline(?bool $allow_decline) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets allow_reassign * diff --git a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php index 9afed3332..fc2bf5987 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php @@ -63,7 +63,6 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'files' => '\SplFileObject[]', 'file_urls' => 'string[]', 'allow_decline' => 'bool', - 'allow_form_view' => 'bool', 'attachments' => '\Dropbox\Sign\Model\SubAttachment[]', 'cc_email_addresses' => 'string[]', 'client_id' => 'string', @@ -84,6 +83,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'use_preexisting_fields' => 'bool', 'use_text_tags' => 'bool', 'expires_at' => 'int', + 'signer_experience' => '\Dropbox\Sign\Model\SubSignerExperience', ]; /** @@ -98,7 +98,6 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'files' => 'binary', 'file_urls' => null, 'allow_decline' => null, - 'allow_form_view' => null, 'attachments' => null, 'cc_email_addresses' => 'email', 'client_id' => null, @@ -119,6 +118,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'use_preexisting_fields' => null, 'use_text_tags' => null, 'expires_at' => null, + 'signer_experience' => null, ]; /** @@ -131,7 +131,6 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'files' => false, 'file_urls' => false, 'allow_decline' => false, - 'allow_form_view' => false, 'attachments' => false, 'cc_email_addresses' => false, 'client_id' => false, @@ -152,6 +151,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'use_preexisting_fields' => false, 'use_text_tags' => false, 'expires_at' => true, + 'signer_experience' => false, ]; /** @@ -236,7 +236,6 @@ public function isNullableSetToNull(string $property): bool 'files' => 'files', 'file_urls' => 'file_urls', 'allow_decline' => 'allow_decline', - 'allow_form_view' => 'allow_form_view', 'attachments' => 'attachments', 'cc_email_addresses' => 'cc_email_addresses', 'client_id' => 'client_id', @@ -257,6 +256,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'use_preexisting_fields', 'use_text_tags' => 'use_text_tags', 'expires_at' => 'expires_at', + 'signer_experience' => 'signer_experience', ]; /** @@ -269,7 +269,6 @@ public function isNullableSetToNull(string $property): bool 'files' => 'setFiles', 'file_urls' => 'setFileUrls', 'allow_decline' => 'setAllowDecline', - 'allow_form_view' => 'setAllowFormView', 'attachments' => 'setAttachments', 'cc_email_addresses' => 'setCcEmailAddresses', 'client_id' => 'setClientId', @@ -290,6 +289,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'setUsePreexistingFields', 'use_text_tags' => 'setUseTextTags', 'expires_at' => 'setExpiresAt', + 'signer_experience' => 'setSignerExperience', ]; /** @@ -302,7 +302,6 @@ public function isNullableSetToNull(string $property): bool 'files' => 'getFiles', 'file_urls' => 'getFileUrls', 'allow_decline' => 'getAllowDecline', - 'allow_form_view' => 'getAllowFormView', 'attachments' => 'getAttachments', 'cc_email_addresses' => 'getCcEmailAddresses', 'client_id' => 'getClientId', @@ -323,6 +322,7 @@ public function isNullableSetToNull(string $property): bool 'use_preexisting_fields' => 'getUsePreexistingFields', 'use_text_tags' => 'getUseTextTags', 'expires_at' => 'getExpiresAt', + 'signer_experience' => 'getSignerExperience', ]; /** @@ -401,7 +401,6 @@ public function __construct(?array $data = null) $this->setIfExists('files', $data ?? [], null); $this->setIfExists('file_urls', $data ?? [], null); $this->setIfExists('allow_decline', $data ?? [], false); - $this->setIfExists('allow_form_view', $data ?? [], false); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('cc_email_addresses', $data ?? [], null); $this->setIfExists('client_id', $data ?? [], null); @@ -422,6 +421,7 @@ public function __construct(?array $data = null) $this->setIfExists('use_preexisting_fields', $data ?? [], false); $this->setIfExists('use_text_tags', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); + $this->setIfExists('signer_experience', $data ?? [], null); } /** @@ -621,33 +621,6 @@ public function setAllowDecline(?bool $allow_decline) return $this; } - /** - * Gets allow_form_view - * - * @return bool|null - */ - public function getAllowFormView() - { - return $this->container['allow_form_view']; - } - - /** - * Sets allow_form_view - * - * @param bool|null $allow_form_view Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - * - * @return self - */ - public function setAllowFormView(?bool $allow_form_view) - { - if (is_null($allow_form_view)) { - throw new InvalidArgumentException('non-nullable allow_form_view cannot be null'); - } - $this->container['allow_form_view'] = $allow_form_view; - - return $this; - } - /** * Gets attachments * @@ -1204,6 +1177,33 @@ public function setExpiresAt(?int $expires_at) return $this; } + /** + * Gets signer_experience + * + * @return SubSignerExperience|null + */ + public function getSignerExperience() + { + return $this->container['signer_experience']; + } + + /** + * Sets signer_experience + * + * @param SubSignerExperience|null $signer_experience signer_experience + * + * @return self + */ + public function setSignerExperience(?SubSignerExperience $signer_experience) + { + if (is_null($signer_experience)) { + throw new InvalidArgumentException('non-nullable signer_experience cannot be null'); + } + $this->container['signer_experience'] = $signer_experience; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/python/README.md b/sdks/python/README.md index d9a3c0faf..a6069279d 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -272,6 +272,7 @@ Class | Method | HTTP request | Description - [SignatureRequestResponseSignatures](docs/SignatureRequestResponseSignatures.md) - [SignatureRequestSendRequest](docs/SignatureRequestSendRequest.md) - [SignatureRequestSendWithTemplateRequest](docs/SignatureRequestSendWithTemplateRequest.md) + - [SignatureRequestSignerExperience](docs/SignatureRequestSignerExperience.md) - [SignatureRequestUpdateRequest](docs/SignatureRequestUpdateRequest.md) - [SubAttachment](docs/SubAttachment.md) - [SubBulkSignerList](docs/SubBulkSignerList.md) @@ -303,6 +304,7 @@ Class | Method | HTTP request | Description - [SubSignatureRequestGroupedSigners](docs/SubSignatureRequestGroupedSigners.md) - [SubSignatureRequestSigner](docs/SubSignatureRequestSigner.md) - [SubSignatureRequestTemplateSigner](docs/SubSignatureRequestTemplateSigner.md) + - [SubSignerExperience](docs/SubSignerExperience.md) - [SubSigningOptions](docs/SubSigningOptions.md) - [SubTeamResponse](docs/SubTeamResponse.md) - [SubTemplateRole](docs/SubTemplateRole.md) diff --git a/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md index b697653fd..1735800ca 100644 --- a/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/python/docs/BulkSendJobGetResponseSignatureRequests.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes | `response_data` | [```List[SignatureRequestResponseDataBase]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```List[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```str``` | The id of the BulkSendJob. | | +| `signer_experience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/EmbeddedEditUrlRequest.md b/sdks/python/docs/EmbeddedEditUrlRequest.md index bfce12c7f..c96c5cd56 100644 --- a/sdks/python/docs/EmbeddedEditUrlRequest.md +++ b/sdks/python/docs/EmbeddedEditUrlRequest.md @@ -6,7 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `allow_edit_ccs` | ```bool``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `cc_roles` | ```List[str]``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `force_signer_roles` | ```bool``` | Provide users the ability to review/edit the template signer roles. | [default to False] | @@ -16,6 +15,7 @@ Name | Type | Description | Notes | `show_preview` | ```bool``` | This allows the requester to enable the editor/preview experience. | [default to False] | | `show_progress_stepper` | ```bool``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to True] | | `test_mode` | ```bool``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to False] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index aa17c91f3..f197c9f27 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -427,6 +427,10 @@ with ApiClient(configuration) as api_client: upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -458,6 +462,7 @@ with ApiClient(configuration) as api_client: open("./example_signature_request.pdf", "rb").read(), ], signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) @@ -538,6 +543,10 @@ with ApiClient(configuration) as api_client: upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", @@ -558,6 +567,7 @@ with ApiClient(configuration) as api_client: subject="Purchase Order", test_mode=True, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) ) @@ -645,6 +655,10 @@ with ApiClient(configuration) as api_client: upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -684,6 +698,7 @@ with ApiClient(configuration) as api_client: ), field_options=field_options, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) @@ -766,6 +781,10 @@ with ApiClient(configuration) as api_client: upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestSigner( name="Jack", email_address="jack@example.com", @@ -797,6 +816,7 @@ with ApiClient(configuration) as api_client: open("./example_signature_request.pdf", "rb").read(), ], signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) @@ -879,6 +899,10 @@ with ApiClient(configuration) as api_client: upload=True, ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", name="George", @@ -899,6 +923,7 @@ with ApiClient(configuration) as api_client: subject="Purchase Order", test_mode=True, signing_options=signing_options, + signer_experience=signer_experience, signers=signers, ) ) diff --git a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md index a49234d0f..738df72c0 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | @@ -29,6 +28,7 @@ Name | Type | Description | Notes | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index 261759720..aae60999f 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md index 0e4918320..4ba819a3e 100644 --- a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | @@ -30,6 +29,7 @@ Name | Type | Description | Notes | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index c0dcf6fd1..909522c65 100644 --- a/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestEditRequest.md b/sdks/python/docs/SignatureRequestEditRequest.md index df4ca3064..28e6a108f 100644 --- a/sdks/python/docs/SignatureRequestEditRequest.md +++ b/sdks/python/docs/SignatureRequestEditRequest.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes | `signers` | [```List[SubSignatureRequestSigner]```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | @@ -31,6 +30,7 @@ Name | Type | Description | Notes | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md index 47b6af51b..895bb770e 100644 --- a/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestEditWithTemplateRequest.md @@ -21,6 +21,7 @@ Name | Type | Description | Notes | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestResponse.md b/sdks/python/docs/SignatureRequestResponse.md index 92a517b3f..57d863bc1 100644 --- a/sdks/python/docs/SignatureRequestResponse.md +++ b/sdks/python/docs/SignatureRequestResponse.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes | `response_data` | [```List[SignatureRequestResponseDataBase]```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```List[SignatureRequestResponseSignatures]```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```str``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `signer_experience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestSendRequest.md b/sdks/python/docs/SignatureRequestSendRequest.md index ac844d8c7..c5c158a42 100644 --- a/sdks/python/docs/SignatureRequestSendRequest.md +++ b/sdks/python/docs/SignatureRequestSendRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `grouped_signers` | [```List[SubSignatureRequestGroupedSigners]```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `client_id` | ```str``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | @@ -32,6 +31,7 @@ Name | Type | Description | Notes | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md index 0278d63a8..254b9799d 100644 --- a/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/python/docs/SignatureRequestSendWithTemplateRequest.md @@ -22,6 +22,7 @@ Name | Type | Description | Notes | `subject` | ```str``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestSignerExperience.md b/sdks/python/docs/SignatureRequestSignerExperience.md new file mode 100644 index 000000000..f9a09d17c --- /dev/null +++ b/sdks/python/docs/SignatureRequestSignerExperience.md @@ -0,0 +1,12 @@ +# SignatureRequestSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `form_view`*_required_ | ```str``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/python/docs/SubSignerExperience.md b/sdks/python/docs/SubSignerExperience.md new file mode 100644 index 000000000..c3e636dda --- /dev/null +++ b/sdks/python/docs/SubSignerExperience.md @@ -0,0 +1,12 @@ +# SubSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +| `form_view` | ```str``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/sdks/python/docs/TemplateApi.md b/sdks/python/docs/TemplateApi.md index bb2544081..a6921af1a 100644 --- a/sdks/python/docs/TemplateApi.md +++ b/sdks/python/docs/TemplateApi.md @@ -117,6 +117,10 @@ with ApiClient(configuration) as api_client: date_format="DD - MM - YYYY", ) + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + signer_roles_1 = models.SubTemplateRole( name="Client", order=0, @@ -195,6 +199,7 @@ with ApiClient(configuration) as api_client: open("./example_signature_request.pdf", "rb").read(), ], field_options=field_options, + signer_experience=signer_experience, signer_roles=signer_roles, form_fields_per_document=form_fields_per_document, merge_fields=merge_fields, @@ -849,6 +854,10 @@ configuration = Configuration( ) with ApiClient(configuration) as api_client: + signer_experience = models.SubSignerExperience( + form_view="disabled", + ) + form_fields_1 = models.SubUpdateFormField( api_id="uniqueIdHere_1", name="New name 1", @@ -865,7 +874,6 @@ with ApiClient(configuration) as api_client: ] template_update_request = models.TemplateUpdateRequest( - allow_form_view=False, title="Test Title", subject="Test Subject", message="Test Message", @@ -873,6 +881,7 @@ with ApiClient(configuration) as api_client: "CC Role 1", "CC Role 2", ], + signer_experience=signer_experience, form_fields=form_fields, ) diff --git a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md index 6726090ef..cde5cce21 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to True] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_roles` | ```List[str]``` | The CC roles that must be assigned when using the template to send a signature request | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -31,6 +30,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to False] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateCreateRequest.md b/sdks/python/docs/TemplateCreateRequest.md index 177b656b9..500094fee 100644 --- a/sdks/python/docs/TemplateCreateRequest.md +++ b/sdks/python/docs/TemplateCreateRequest.md @@ -10,7 +10,6 @@ Name | Type | Description | Notes | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_roles` | ```List[str]``` | The CC roles that must be assigned when using the template to send a signature request | | | `client_id` | ```str``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | @@ -24,6 +23,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to False] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index 2fa9c367b..ca48138fa 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes | `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments` | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `signer_experience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateUpdateRequest.md b/sdks/python/docs/TemplateUpdateRequest.md index 0b43db639..95400227e 100644 --- a/sdks/python/docs/TemplateUpdateRequest.md +++ b/sdks/python/docs/TemplateUpdateRequest.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `cc_roles` | ```List[str]``` | The CC roles that must be assigned when using the template to send a signature request. | | -| `allow_form_view` | ```bool``` | The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. | | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `subject` | ```str``` | The new default template email subject. | | | `message` | ```str``` | The new default template email message. | | | `form_fields` | [```List[SubUpdateFormField]```](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md index 9e10bd844..49704d25b 100644 --- a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -11,7 +11,6 @@ Name | Type | Description | Notes | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```bool``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to True] | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `allow_reassign` | ```bool``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | diff --git a/sdks/python/docs/UnclaimedDraftCreateRequest.md b/sdks/python/docs/UnclaimedDraftCreateRequest.md index d2893afb0..12cd41d36 100644 --- a/sdks/python/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateRequest.md @@ -9,7 +9,6 @@ Name | Type | Description | Notes | `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_decline` | ```bool``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to False] | -| `allow_form_view` | ```bool``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to False] | | `attachments` | [```List[SubAttachment]```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```List[str]``` | The email addresses that should be CCed. | | | `client_id` | ```str``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | @@ -30,6 +29,7 @@ Name | Type | Description | Notes | `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to False] | | `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/dropbox_sign/__init__.py b/sdks/python/dropbox_sign/__init__.py index 7333f4019..b8bcda925 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -205,6 +205,9 @@ from dropbox_sign.models.signature_request_send_with_template_request import ( SignatureRequestSendWithTemplateRequest, ) +from dropbox_sign.models.signature_request_signer_experience import ( + SignatureRequestSignerExperience, +) from dropbox_sign.models.signature_request_update_request import ( SignatureRequestUpdateRequest, ) @@ -270,6 +273,7 @@ from dropbox_sign.models.sub_signature_request_template_signer import ( SubSignatureRequestTemplateSigner, ) +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from dropbox_sign.models.sub_team_response import SubTeamResponse from dropbox_sign.models.sub_template_role import SubTemplateRole diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index 5ce58f513..ed2b055dc 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -188,6 +188,9 @@ from dropbox_sign.models.signature_request_send_with_template_request import ( SignatureRequestSendWithTemplateRequest, ) +from dropbox_sign.models.signature_request_signer_experience import ( + SignatureRequestSignerExperience, +) from dropbox_sign.models.signature_request_update_request import ( SignatureRequestUpdateRequest, ) @@ -253,6 +256,7 @@ from dropbox_sign.models.sub_signature_request_template_signer import ( SubSignatureRequestTemplateSigner, ) +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from dropbox_sign.models.sub_team_response import SubTeamResponse from dropbox_sign.models.sub_template_role import SubTemplateRole diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py index 704089bef..f2e96d38b 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py @@ -32,6 +32,9 @@ from dropbox_sign.models.signature_request_response_signatures import ( SignatureRequestResponseSignatures, ) +from dropbox_sign.models.signature_request_signer_experience import ( + SignatureRequestSignerExperience, +) from typing import Optional, Set from typing_extensions import Self from typing import Tuple, Union @@ -137,6 +140,7 @@ class BulkSendJobGetResponseSignatureRequests(BaseModel): bulk_send_job_id: Optional[StrictStr] = Field( default=None, description="The id of the BulkSendJob." ) + signer_experience: Optional[SignatureRequestSignerExperience] = None __properties: ClassVar[List[str]] = [ "test_mode", "signature_request_id", @@ -163,6 +167,7 @@ class BulkSendJobGetResponseSignatureRequests(BaseModel): "response_data", "signatures", "bulk_send_job_id", + "signer_experience", ] model_config = ConfigDict( @@ -243,6 +248,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_signatures: _items.append(_item_signatures.to_dict()) _dict["signatures"] = _items + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -311,6 +319,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else None ), "bulk_send_job_id": obj.get("bulk_send_job_id"), + "signer_experience": ( + SignatureRequestSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -353,6 +366,7 @@ def openapi_types(cls) -> Dict[str, str]: "response_data": "(List[SignatureRequestResponseDataBase],)", "signatures": "(List[SignatureRequestResponseSignatures],)", "bulk_send_job_id": "(str,)", + "signer_experience": "(SignatureRequestSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py index 1c2bad53a..5cd7d6428 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py @@ -22,6 +22,7 @@ from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.sub_editor_options import SubEditorOptions from dropbox_sign.models.sub_merge_field import SubMergeField +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from typing import Optional, Set from typing_extensions import Self from typing import Tuple, Union @@ -38,10 +39,6 @@ class EmbeddedEditUrlRequest(BaseModel): default=False, description="This allows the requester to enable/disable to add or change CC roles when editing the template.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) cc_roles: Optional[List[StrictStr]] = Field( default=None, description="The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.", @@ -75,9 +72,9 @@ class EmbeddedEditUrlRequest(BaseModel): default=False, description="Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "allow_edit_ccs", - "allow_form_view", "cc_roles", "editor_options", "force_signer_roles", @@ -87,6 +84,7 @@ class EmbeddedEditUrlRequest(BaseModel): "show_preview", "show_progress_stepper", "test_mode", + "signer_experience", ] model_config = ConfigDict( @@ -149,6 +147,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_merge_fields: _items.append(_item_merge_fields.to_dict()) _dict["merge_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -167,11 +168,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_edit_ccs") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "cc_roles": obj.get("cc_roles"), "editor_options": ( SubEditorOptions.from_dict(obj["editor_options"]) @@ -211,6 +207,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "test_mode": ( obj.get("test_mode") if obj.get("test_mode") is not None else False ), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -229,7 +230,6 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "allow_edit_ccs": "(bool,)", - "allow_form_view": "(bool,)", "cc_roles": "(List[str],)", "editor_options": "(SubEditorOptions,)", "force_signer_roles": "(bool,)", @@ -239,6 +239,7 @@ def openapi_types(cls) -> Dict[str, str]: "show_preview": "(bool,)", "show_progress_stepper": "(bool,)", "test_mode": "(bool,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py index d1e40719d..11c173c05 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py @@ -41,6 +41,7 @@ SubSignatureRequestGroupedSigners, ) from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -79,10 +80,6 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.", @@ -143,6 +140,7 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): default=False, description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", ) + signer_experience: Optional[SubSignerExperience] = None expires_at: Optional[StrictInt] = Field( default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", @@ -154,7 +152,6 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): "signers", "grouped_signers", "allow_decline", - "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -172,6 +169,7 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): "title", "use_text_tags", "populate_auto_fill_fields", + "signer_experience", "expires_at", ] @@ -280,6 +278,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -317,11 +318,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -394,6 +390,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("populate_auto_fill_fields") is not None else False ), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), "expires_at": obj.get("expires_at"), } ) @@ -418,7 +419,6 @@ def openapi_types(cls) -> Dict[str, str]: "signers": "(List[SubSignatureRequestSigner],)", "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", - "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", @@ -436,6 +436,7 @@ def openapi_types(cls) -> Dict[str, str]: "title": "(str,)", "use_text_tags": "(bool,)", "populate_auto_fill_fields": "(bool,)", + "signer_experience": "(SubSignerExperience,)", "expires_at": "(int,)", } diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index 07c2d0cfe..d3e119b8d 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -26,6 +26,7 @@ from dropbox_sign.models.sub_signature_request_template_signer import ( SubSignatureRequestTemplateSigner, ) +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -95,6 +96,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): default=False, description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "template_ids", "client_id", @@ -111,6 +113,7 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest(BaseModel): "test_mode", "title", "populate_auto_fill_fields", + "signer_experience", ] model_config = ConfigDict( @@ -187,6 +190,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -244,6 +250,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("populate_auto_fill_fields") is not None else False ), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -276,6 +287,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "populate_auto_fill_fields": "(bool,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py index 68f16138a..d20551467 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py @@ -41,6 +41,7 @@ SubSignatureRequestGroupedSigners, ) from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -79,10 +80,6 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.", @@ -147,6 +144,7 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "client_id", "files", @@ -154,7 +152,6 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): "signers", "grouped_signers", "allow_decline", - "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -173,6 +170,7 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): "use_text_tags", "populate_auto_fill_fields", "expires_at", + "signer_experience", ] model_config = ConfigDict( @@ -280,6 +278,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -317,11 +318,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -395,6 +391,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else False ), "expires_at": obj.get("expires_at"), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -418,7 +419,6 @@ def openapi_types(cls) -> Dict[str, str]: "signers": "(List[SubSignatureRequestSigner],)", "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", - "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", @@ -437,6 +437,7 @@ def openapi_types(cls) -> Dict[str, str]: "use_text_tags": "(bool,)", "populate_auto_fill_fields": "(bool,)", "expires_at": "(int,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py index 0061169bb..dc391c024 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py @@ -26,6 +26,7 @@ from dropbox_sign.models.sub_signature_request_template_signer import ( SubSignatureRequestTemplateSigner, ) +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -95,6 +96,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest(BaseModel): default=False, description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "template_ids", "client_id", @@ -111,6 +113,7 @@ class SignatureRequestEditEmbeddedWithTemplateRequest(BaseModel): "test_mode", "title", "populate_auto_fill_fields", + "signer_experience", ] model_config = ConfigDict( @@ -187,6 +190,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -244,6 +250,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("populate_auto_fill_fields") is not None else False ), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -276,6 +287,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "populate_auto_fill_fields": "(bool,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_request.py index 27e8299dc..b92584ee3 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_request.py @@ -41,6 +41,7 @@ SubSignatureRequestGroupedSigners, ) from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -76,10 +77,6 @@ class SignatureRequestEditRequest(BaseModel): default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", @@ -152,13 +149,13 @@ class SignatureRequestEditRequest(BaseModel): default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "files", "file_urls", "signers", "grouped_signers", "allow_decline", - "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -179,6 +176,7 @@ class SignatureRequestEditRequest(BaseModel): "title", "use_text_tags", "expires_at", + "signer_experience", ] model_config = ConfigDict( @@ -286,6 +284,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -322,11 +323,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -398,6 +394,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else False ), "expires_at": obj.get("expires_at"), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -420,7 +421,6 @@ def openapi_types(cls) -> Dict[str, str]: "signers": "(List[SubSignatureRequestSigner],)", "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", - "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", @@ -441,6 +441,7 @@ def openapi_types(cls) -> Dict[str, str]: "title": "(str,)", "use_text_tags": "(bool,)", "expires_at": "(int,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py index fedc9afd5..cab644429 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py @@ -26,6 +26,7 @@ from dropbox_sign.models.sub_signature_request_template_signer import ( SubSignatureRequestTemplateSigner, ) +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -98,6 +99,7 @@ class SignatureRequestEditWithTemplateRequest(BaseModel): default=None, description="The title you want to assign to the SignatureRequest.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "template_ids", "signers", @@ -115,6 +117,7 @@ class SignatureRequestEditWithTemplateRequest(BaseModel): "subject", "test_mode", "title", + "signer_experience", ] model_config = ConfigDict( @@ -191,6 +194,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -245,6 +251,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: obj.get("test_mode") if obj.get("test_mode") is not None else False ), "title": obj.get("title"), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -278,6 +289,7 @@ def openapi_types(cls) -> Dict[str, str]: "subject": "(str,)", "test_mode": "(bool,)", "title": "(str,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_response.py b/sdks/python/dropbox_sign/models/signature_request_response.py index 7720256b8..3c7ce3b23 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_response.py @@ -32,6 +32,9 @@ from dropbox_sign.models.signature_request_response_signatures import ( SignatureRequestResponseSignatures, ) +from dropbox_sign.models.signature_request_signer_experience import ( + SignatureRequestSignerExperience, +) from typing import Optional, Set from typing_extensions import Self from typing import Tuple, Union @@ -138,6 +141,7 @@ class SignatureRequestResponse(BaseModel): default=None, description="The ID of the Bulk Send job which sent the signature request, if applicable.", ) + signer_experience: Optional[SignatureRequestSignerExperience] = None __properties: ClassVar[List[str]] = [ "test_mode", "signature_request_id", @@ -164,6 +168,7 @@ class SignatureRequestResponse(BaseModel): "response_data", "signatures", "bulk_send_job_id", + "signer_experience", ] model_config = ConfigDict( @@ -244,6 +249,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_signatures: _items.append(_item_signatures.to_dict()) _dict["signatures"] = _items + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -312,6 +320,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else None ), "bulk_send_job_id": obj.get("bulk_send_job_id"), + "signer_experience": ( + SignatureRequestSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -354,6 +367,7 @@ def openapi_types(cls) -> Dict[str, str]: "response_data": "(List[SignatureRequestResponseDataBase],)", "signatures": "(List[SignatureRequestResponseSignatures],)", "bulk_send_job_id": "(str,)", + "signer_experience": "(SignatureRequestSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_send_request.py b/sdks/python/dropbox_sign/models/signature_request_send_request.py index e3cf14008..15ad59701 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_request.py @@ -41,6 +41,7 @@ SubSignatureRequestGroupedSigners, ) from dropbox_sign.models.sub_signature_request_signer import SubSignatureRequestSigner +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -80,10 +81,6 @@ class SignatureRequestSendRequest(BaseModel): default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) attachments: Optional[List[SubAttachment]] = Field( default=None, description="A list describing the attachments" ) @@ -156,6 +153,7 @@ class SignatureRequestSendRequest(BaseModel): default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "files", "file_urls", @@ -163,7 +161,6 @@ class SignatureRequestSendRequest(BaseModel): "grouped_signers", "allow_decline", "allow_reassign", - "allow_form_view", "attachments", "cc_email_addresses", "client_id", @@ -184,6 +181,7 @@ class SignatureRequestSendRequest(BaseModel): "title", "use_text_tags", "expires_at", + "signer_experience", ] model_config = ConfigDict( @@ -291,6 +289,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -332,11 +333,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_reassign") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -408,6 +404,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else False ), "expires_at": obj.get("expires_at"), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -431,7 +432,6 @@ def openapi_types(cls) -> Dict[str, str]: "grouped_signers": "(List[SubSignatureRequestGroupedSigners],)", "allow_decline": "(bool,)", "allow_reassign": "(bool,)", - "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", "client_id": "(str,)", @@ -452,6 +452,7 @@ def openapi_types(cls) -> Dict[str, str]: "title": "(str,)", "use_text_tags": "(bool,)", "expires_at": "(int,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py index f09727801..3621f51dd 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py @@ -26,6 +26,7 @@ from dropbox_sign.models.sub_signature_request_template_signer import ( SubSignatureRequestTemplateSigner, ) +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from typing import Optional, Set from typing_extensions import Self @@ -102,6 +103,7 @@ class SignatureRequestSendWithTemplateRequest(BaseModel): default=None, description="The title you want to assign to the SignatureRequest.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "template_ids", "signers", @@ -120,6 +122,7 @@ class SignatureRequestSendWithTemplateRequest(BaseModel): "subject", "test_mode", "title", + "signer_experience", ] model_config = ConfigDict( @@ -196,6 +199,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -255,6 +261,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: obj.get("test_mode") if obj.get("test_mode") is not None else False ), "title": obj.get("title"), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -289,6 +300,7 @@ def openapi_types(cls) -> Dict[str, str]: "subject": "(str,)", "test_mode": "(bool,)", "title": "(str,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/signature_request_signer_experience.py b/sdks/python/dropbox_sign/models/signature_request_signer_experience.py new file mode 100644 index 000000000..36e6351e0 --- /dev/null +++ b/sdks/python/dropbox_sign/models/signature_request_signer_experience.py @@ -0,0 +1,131 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class SignatureRequestSignerExperience(BaseModel): + """ + Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + """ # noqa: E501 + + form_view: StrictStr = Field( + description="Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden." + ) + __properties: ClassVar[List[str]] = ["form_view"] + + @field_validator("form_view") + def form_view_validate_enum(cls, value): + """Validates the enum""" + if value not in set(["disabled", "enabled", "enabled_by_default", "forced"]): + raise ValueError( + "must be one of enum values ('disabled', 'enabled', 'enabled_by_default', 'forced')" + ) + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SignatureRequestSignerExperience from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SignatureRequestSignerExperience from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({"form_view": obj.get("form_view")}) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "form_view": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [] diff --git a/sdks/python/dropbox_sign/models/sub_signer_experience.py b/sdks/python/dropbox_sign/models/sub_signer_experience.py new file mode 100644 index 000000000..805186f7b --- /dev/null +++ b/sdks/python/dropbox_sign/models/sub_signer_experience.py @@ -0,0 +1,135 @@ +# coding: utf-8 + +""" +Dropbox Sign API + +Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self +from typing import Tuple, Union +import io +from pydantic import StrictBool + + +class SubSignerExperience(BaseModel): + """ + Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + """ # noqa: E501 + + form_view: Optional[StrictStr] = Field( + default=None, + description="Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden.", + ) + __properties: ClassVar[List[str]] = ["form_view"] + + @field_validator("form_view") + def form_view_validate_enum(cls, value): + """Validates the enum""" + if value is None: + return value + + if value not in set(["disabled", "enabled", "enabled_by_default", "forced"]): + raise ValueError( + "must be one of enum values ('disabled', 'enabled', 'enabled_by_default', 'forced')" + ) + return value + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + arbitrary_types_allowed=True, + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + def to_json_form_params( + self, excluded_fields: Set[str] = None + ) -> List[Tuple[str, str]]: + data: List[Tuple[str, str]] = [] + + for key, value in self.to_dict(excluded_fields).items(): + if isinstance(value, (int, str, bool)): + data.append((key, value)) + else: + data.append((key, json.dumps(value, ensure_ascii=False))) + + return data + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SubSignerExperience from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SubSignerExperience from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({"form_view": obj.get("form_view")}) + return _obj + + @classmethod + def init(cls, data: Any) -> Self: + """ + Attempt to instantiate and hydrate a new instance of this class + """ + if isinstance(data, str): + data = json.loads(data) + + return cls.from_dict(data) + + @classmethod + def openapi_types(cls) -> Dict[str, str]: + return { + "form_view": "(str,)", + } + + @classmethod + def openapi_type_is_array(cls, property_name: str) -> bool: + return property_name in [] diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py index cbf1ff24f..27cbb91c7 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py @@ -30,6 +30,7 @@ SubFormFieldsPerDocumentBase, ) from dropbox_sign.models.sub_merge_field import SubMergeField +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_template_role import SubTemplateRole from typing import Optional, Set from typing_extensions import Self @@ -64,10 +65,6 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) attachments: Optional[List[SubAttachment]] = Field( default=None, description="A list describing the attachments" ) @@ -139,13 +136,13 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): default=False, description="Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "client_id", "files", "file_urls", "allow_ccs", "allow_reassign", - "allow_form_view", "attachments", "cc_roles", "editor_options", @@ -166,6 +163,7 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): "test_mode", "title", "use_preexisting_fields", + "signer_experience", ] model_config = ConfigDict( @@ -266,6 +264,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_signer_roles: _items.append(_item_signer_roles.to_dict()) _dict["signer_roles"] = _items + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -290,11 +291,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_reassign") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -382,6 +378,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_preexisting_fields") is not None else False ), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -404,7 +405,6 @@ def openapi_types(cls) -> Dict[str, str]: "file_urls": "(List[str],)", "allow_ccs": "(bool,)", "allow_reassign": "(bool,)", - "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_roles": "(List[str],)", "editor_options": "(SubEditorOptions,)", @@ -425,6 +425,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_preexisting_fields": "(bool,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_create_request.py b/sdks/python/dropbox_sign/models/template_create_request.py index 349193c3e..5f6f227a3 100644 --- a/sdks/python/dropbox_sign/models/template_create_request.py +++ b/sdks/python/dropbox_sign/models/template_create_request.py @@ -29,6 +29,7 @@ SubFormFieldsPerDocumentBase, ) from dropbox_sign.models.sub_merge_field import SubMergeField +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_template_role import SubTemplateRole from typing import Optional, Set from typing_extensions import Self @@ -62,10 +63,6 @@ class TemplateCreateRequest(BaseModel): default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) attachments: Optional[List[SubAttachment]] = Field( default=None, description="A list describing the attachments" ) @@ -112,13 +109,13 @@ class TemplateCreateRequest(BaseModel): default=False, description="Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "form_fields_per_document", "signer_roles", "files", "file_urls", "allow_reassign", - "allow_form_view", "attachments", "cc_roles", "client_id", @@ -132,6 +129,7 @@ class TemplateCreateRequest(BaseModel): "test_mode", "title", "use_preexisting_fields", + "signer_experience", ] model_config = ConfigDict( @@ -229,6 +227,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_merge_fields: _items.append(_item_merge_fields.to_dict()) _dict["merge_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -262,11 +263,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_reassign") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -312,6 +308,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_preexisting_fields") is not None else False ), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -334,7 +335,6 @@ def openapi_types(cls) -> Dict[str, str]: "files": "(List[io.IOBase],)", "file_urls": "(List[str],)", "allow_reassign": "(bool,)", - "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_roles": "(List[str],)", "client_id": "(str,)", @@ -348,6 +348,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_preexisting_fields": "(bool,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index e77433d56..0dd3d12dc 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -23,6 +23,9 @@ from dropbox_sign.models.signature_request_response_attachment import ( SignatureRequestResponseAttachment, ) +from dropbox_sign.models.signature_request_signer_experience import ( + SignatureRequestSignerExperience, +) from dropbox_sign.models.template_response_account import TemplateResponseAccount from dropbox_sign.models.template_response_cc_role import TemplateResponseCCRole from dropbox_sign.models.template_response_document import TemplateResponseDocument @@ -104,10 +107,7 @@ class TemplateResponse(BaseModel): attachments: Optional[List[SignatureRequestResponseAttachment]] = Field( default=None, description="Signer attachments." ) - allow_form_view: Optional[StrictBool] = Field( - default=None, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) + signer_experience: Optional[SignatureRequestSignerExperience] = None __properties: ClassVar[List[str]] = [ "template_id", "title", @@ -125,7 +125,7 @@ class TemplateResponse(BaseModel): "named_form_fields", "accounts", "attachments", - "allow_form_view", + "signer_experience", ] model_config = ConfigDict( @@ -227,6 +227,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_attachments: _items.append(_item_attachments.to_dict()) _dict["attachments"] = _items + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -305,7 +308,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("attachments") is not None else None ), - "allow_form_view": obj.get("allow_form_view"), + "signer_experience": ( + SignatureRequestSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -339,7 +346,7 @@ def openapi_types(cls) -> Dict[str, str]: "named_form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", "accounts": "(List[TemplateResponseAccount],)", "attachments": "(List[SignatureRequestResponseAttachment],)", - "allow_form_view": "(bool,)", + "signer_experience": "(SignatureRequestSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_update_request.py b/sdks/python/dropbox_sign/models/template_update_request.py index 1f924b35b..76ae07cd0 100644 --- a/sdks/python/dropbox_sign/models/template_update_request.py +++ b/sdks/python/dropbox_sign/models/template_update_request.py @@ -18,9 +18,10 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_update_form_field import SubUpdateFormField from typing import Optional, Set from typing_extensions import Self @@ -38,10 +39,6 @@ class TemplateUpdateRequest(BaseModel): default=None, description="The CC roles that must be assigned when using the template to send a signature request.", ) - allow_form_view: Optional[StrictBool] = Field( - default=None, - description="The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names.", - ) title: Optional[StrictStr] = Field( default=None, description="The title you want to assign to the SignatureRequest.", @@ -56,13 +53,14 @@ class TemplateUpdateRequest(BaseModel): default=None, description="A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "cc_roles", - "allow_form_view", "title", "subject", "message", "form_fields", + "signer_experience", ] model_config = ConfigDict( @@ -122,6 +120,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_form_fields: _items.append(_item_form_fields.to_dict()) _dict["form_fields"] = _items + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -136,7 +137,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "cc_roles": obj.get("cc_roles"), - "allow_form_view": obj.get("allow_form_view"), "title": obj.get("title"), "subject": obj.get("subject"), "message": obj.get("message"), @@ -148,6 +148,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("form_fields") is not None else None ), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -166,11 +171,11 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "cc_roles": "(List[str],)", - "allow_form_view": "(bool,)", "title": "(str,)", "subject": "(str,)", "message": "(str,)", "form_fields": "(List[SubUpdateFormField],)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 0b69ecc1a..53527e34c 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py @@ -75,10 +75,6 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) allow_reassign: Optional[StrictBool] = Field( default=False, description="Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.", @@ -195,7 +191,6 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): "file_urls", "allow_ccs", "allow_decline", - "allow_form_view", "allow_reassign", "attachments", "cc_email_addresses", @@ -366,11 +361,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "allow_reassign": ( obj.get("allow_reassign") if obj.get("allow_reassign") is not None @@ -522,7 +512,6 @@ def openapi_types(cls) -> Dict[str, str]: "file_urls": "(List[str],)", "allow_ccs": "(bool,)", "allow_decline": "(bool,)", - "allow_form_view": "(bool,)", "allow_reassign": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py index 9c74b2fe4..bb53acb2b 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py @@ -38,6 +38,7 @@ from dropbox_sign.models.sub_form_fields_per_document_base import ( SubFormFieldsPerDocumentBase, ) +from dropbox_sign.models.sub_signer_experience import SubSignerExperience from dropbox_sign.models.sub_signing_options import SubSigningOptions from dropbox_sign.models.sub_unclaimed_draft_signer import SubUnclaimedDraftSigner from typing import Optional, Set @@ -67,10 +68,6 @@ class UnclaimedDraftCreateRequest(BaseModel): default=False, description="Allows signers to decline to sign a document if `true`. Defaults to `false`.", ) - allow_form_view: Optional[StrictBool] = Field( - default=False, - description="Allows signers to view the form fields before signing if set to `true`. Defaults to `false`.", - ) attachments: Optional[List[SubAttachment]] = Field( default=None, description="A list describing the attachments" ) @@ -143,12 +140,12 @@ class UnclaimedDraftCreateRequest(BaseModel): default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.", ) + signer_experience: Optional[SubSignerExperience] = None __properties: ClassVar[List[str]] = [ "type", "files", "file_urls", "allow_decline", - "allow_form_view", "attachments", "cc_email_addresses", "client_id", @@ -169,6 +166,7 @@ class UnclaimedDraftCreateRequest(BaseModel): "use_preexisting_fields", "use_text_tags", "expires_at", + "signer_experience", ] @field_validator("type") @@ -278,6 +276,9 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: # override the default output from pydantic by calling `to_dict()` of signing_options if self.signing_options: _dict["signing_options"] = self.signing_options.to_dict() + # override the default output from pydantic by calling `to_dict()` of signer_experience + if self.signer_experience: + _dict["signer_experience"] = self.signer_experience.to_dict() return _dict @classmethod @@ -299,11 +300,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("allow_decline") is not None else False ), - "allow_form_view": ( - obj.get("allow_form_view") - if obj.get("allow_form_view") is not None - else False - ), "attachments": ( [SubAttachment.from_dict(_item) for _item in obj["attachments"]] if obj.get("attachments") is not None @@ -386,6 +382,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else False ), "expires_at": obj.get("expires_at"), + "signer_experience": ( + SubSignerExperience.from_dict(obj["signer_experience"]) + if obj.get("signer_experience") is not None + else None + ), } ) return _obj @@ -407,7 +408,6 @@ def openapi_types(cls) -> Dict[str, str]: "files": "(List[io.IOBase],)", "file_urls": "(List[str],)", "allow_decline": "(bool,)", - "allow_form_view": "(bool,)", "attachments": "(List[SubAttachment],)", "cc_email_addresses": "(List[str],)", "client_id": "(str,)", @@ -428,6 +428,7 @@ def openapi_types(cls) -> Dict[str, str]: "use_preexisting_fields": "(bool,)", "use_text_tags": "(bool,)", "expires_at": "(int,)", + "signer_experience": "(SubSignerExperience,)", } @classmethod diff --git a/sdks/python/tests/test_signature_request_api.py b/sdks/python/tests/test_signature_request_api.py index 3bf40b572..53f7fc362 100644 --- a/sdks/python/tests/test_signature_request_api.py +++ b/sdks/python/tests/test_signature_request_api.py @@ -131,9 +131,9 @@ def test_init_allows_jsony_chars_in_strings(self): fields = self.mock_pool.get_fields() - title_result = fields[10] - subject_result = fields[8] - message_result = fields[7] + title_result = fields[9] + subject_result = fields[7] + message_result = fields[6] self.assertEqual(title_result[1], title) self.assertEqual(subject_result[1], subject) diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index e925ed63a..be4aefd20 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -276,6 +276,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::SignatureRequestResponseSignatures](docs/SignatureRequestResponseSignatures.md) - [Dropbox::Sign::SignatureRequestSendRequest](docs/SignatureRequestSendRequest.md) - [Dropbox::Sign::SignatureRequestSendWithTemplateRequest](docs/SignatureRequestSendWithTemplateRequest.md) + - [Dropbox::Sign::SignatureRequestSignerExperience](docs/SignatureRequestSignerExperience.md) - [Dropbox::Sign::SignatureRequestUpdateRequest](docs/SignatureRequestUpdateRequest.md) - [Dropbox::Sign::SubAttachment](docs/SubAttachment.md) - [Dropbox::Sign::SubBulkSignerList](docs/SubBulkSignerList.md) @@ -307,6 +308,7 @@ All URIs are relative to *https://api.hellosign.com/v3* - [Dropbox::Sign::SubSignatureRequestGroupedSigners](docs/SubSignatureRequestGroupedSigners.md) - [Dropbox::Sign::SubSignatureRequestSigner](docs/SubSignatureRequestSigner.md) - [Dropbox::Sign::SubSignatureRequestTemplateSigner](docs/SubSignatureRequestTemplateSigner.md) + - [Dropbox::Sign::SubSignerExperience](docs/SubSignerExperience.md) - [Dropbox::Sign::SubSigningOptions](docs/SubSigningOptions.md) - [Dropbox::Sign::SubTeamResponse](docs/SubTeamResponse.md) - [Dropbox::Sign::SubTemplateRole](docs/SubTemplateRole.md) diff --git a/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md b/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md index 8491cfeeb..bde57dc0c 100644 --- a/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md +++ b/sdks/ruby/docs/BulkSendJobGetResponseSignatureRequests.md @@ -31,4 +31,5 @@ | `response_data` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```String``` | The id of the BulkSendJob. | | +| `signer_experience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/ruby/docs/EmbeddedEditUrlRequest.md b/sdks/ruby/docs/EmbeddedEditUrlRequest.md index 6395cb460..fdc2ab3d7 100644 --- a/sdks/ruby/docs/EmbeddedEditUrlRequest.md +++ b/sdks/ruby/docs/EmbeddedEditUrlRequest.md @@ -7,7 +7,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `allow_edit_ccs` | ```Boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | | `force_signer_roles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | [default to false] | @@ -17,4 +16,5 @@ | `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience. | [default to false] | | `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] | | `test_mode` | ```Boolean``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to false] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestApi.md b/sdks/ruby/docs/SignatureRequestApi.md index 964273c5f..782ede630 100644 --- a/sdks/ruby/docs/SignatureRequestApi.md +++ b/sdks/ruby/docs/SignatureRequestApi.md @@ -391,6 +391,9 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -420,6 +423,7 @@ signature_request_create_embedded_request.files = [ File.new("./example_signature_request.pdf", "r"), ] signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signer_experience = signer_experience signature_request_create_embedded_request.signers = signers begin @@ -498,6 +502,9 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" @@ -516,6 +523,7 @@ signature_request_create_embedded_with_template_request.message = "Glad we could signature_request_create_embedded_with_template_request.subject = "Purchase Order" signature_request_create_embedded_with_template_request.test_mode = true signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signer_experience = signer_experience signature_request_create_embedded_with_template_request.signers = signers begin @@ -597,6 +605,9 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -633,6 +644,7 @@ signature_request_edit_request.metadata = JSON.parse(<<-EOD ) signature_request_edit_request.field_options = field_options signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signer_experience = signer_experience signature_request_edit_request.signers = signers begin @@ -713,6 +725,9 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" signers_1.email_address = "jack@example.com" @@ -742,6 +757,7 @@ signature_request_edit_embedded_request.files = [ File.new("./example_signature_request.pdf", "r"), ] signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signer_experience = signer_experience signature_request_edit_embedded_request.signers = signers begin @@ -822,6 +838,9 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" signers_1.name = "George" @@ -840,6 +859,7 @@ signature_request_edit_embedded_with_template_request.message = "Glad we could c signature_request_edit_embedded_with_template_request.subject = "Purchase Order" signature_request_edit_embedded_with_template_request.test_mode = true signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signer_experience = signer_experience signature_request_edit_embedded_with_template_request.signers = signers begin diff --git a/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md index abda999ce..49145ae77 100644 --- a/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md @@ -12,7 +12,6 @@ | `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | @@ -30,5 +29,6 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md index a345e97b1..c8890b8cf 100644 --- a/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md @@ -21,4 +21,5 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md index 91bfc59db..41ff54e91 100644 --- a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md @@ -12,7 +12,6 @@ | `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | @@ -31,4 +30,5 @@ | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md index 736cbf786..5cc5e0c24 100644 --- a/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -21,4 +21,5 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestEditRequest.md b/sdks/ruby/docs/SignatureRequestEditRequest.md index 97f790ab0..c74c363e0 100644 --- a/sdks/ruby/docs/SignatureRequestEditRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditRequest.md @@ -11,7 +11,6 @@ | `signers` | [```Array```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | @@ -32,4 +31,5 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md index 12b4bee82..dc584f746 100644 --- a/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditWithTemplateRequest.md @@ -22,4 +22,5 @@ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestResponse.md b/sdks/ruby/docs/SignatureRequestResponse.md index f3655a0a2..f04726ff6 100644 --- a/sdks/ruby/docs/SignatureRequestResponse.md +++ b/sdks/ruby/docs/SignatureRequestResponse.md @@ -31,4 +31,5 @@ Contains information about a signature request. | `response_data` | [```Array```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | | | `signatures` | [```Array```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | | | `bulk_send_job_id` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | | +| `signer_experience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestSendRequest.md b/sdks/ruby/docs/SignatureRequestSendRequest.md index 34d35db42..4acc0c3bc 100644 --- a/sdks/ruby/docs/SignatureRequestSendRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendRequest.md @@ -12,7 +12,6 @@ | `grouped_signers` | [```Array```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `client_id` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | @@ -33,4 +32,5 @@ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md b/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md index 94e17b8bf..46b8c2eac 100644 --- a/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendWithTemplateRequest.md @@ -23,4 +23,5 @@ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | | | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/SignatureRequestSignerExperience.md b/sdks/ruby/docs/SignatureRequestSignerExperience.md new file mode 100644 index 000000000..9a38226ed --- /dev/null +++ b/sdks/ruby/docs/SignatureRequestSignerExperience.md @@ -0,0 +1,10 @@ +# Dropbox::Sign::SignatureRequestSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `form_view`*_required_ | ```String``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + diff --git a/sdks/ruby/docs/SubSignerExperience.md b/sdks/ruby/docs/SubSignerExperience.md new file mode 100644 index 000000000..809e1156f --- /dev/null +++ b/sdks/ruby/docs/SubSignerExperience.md @@ -0,0 +1,10 @@ +# Dropbox::Sign::SubSignerExperience + +Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + +## Properties + +| Name | Type | Description | Notes | +| ---- | ---- | ----------- | ----- | +| `form_view` | ```String``` | Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. | | + diff --git a/sdks/ruby/docs/TemplateApi.md b/sdks/ruby/docs/TemplateApi.md index 7c9ccb405..bfe23251f 100644 --- a/sdks/ruby/docs/TemplateApi.md +++ b/sdks/ruby/docs/TemplateApi.md @@ -114,6 +114,9 @@ end field_options = Dropbox::Sign::SubFieldOptions.new field_options.date_format = "DD - MM - YYYY" +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + signer_roles_1 = Dropbox::Sign::SubTemplateRole.new signer_roles_1.name = "Client" signer_roles_1.order = 0 @@ -186,6 +189,7 @@ template_create_request.files = [ File.new("./example_signature_request.pdf", "r"), ] template_create_request.field_options = field_options +template_create_request.signer_experience = signer_experience template_create_request.signer_roles = signer_roles template_create_request.form_fields_per_document = form_fields_per_document template_create_request.merge_fields = merge_fields @@ -872,6 +876,9 @@ Dropbox::Sign.configure do |config| # config.access_token = "YOUR_ACCESS_TOKEN" end +signer_experience = Dropbox::Sign::SubSignerExperience.new +signer_experience.form_view = "disabled" + form_fields_1 = Dropbox::Sign::SubUpdateFormField.new form_fields_1.api_id = "uniqueIdHere_1" form_fields_1.name = "New name 1" @@ -886,7 +893,6 @@ form_fields = [ ] template_update_request = Dropbox::Sign::TemplateUpdateRequest.new -template_update_request.allow_form_view = false template_update_request.title = "Test Title" template_update_request.subject = "Test Subject" template_update_request.message = "Test Message" @@ -894,6 +900,7 @@ template_update_request.cc_roles = [ "CC Role 1", "CC Role 2", ] +template_update_request.signer_experience = signer_experience template_update_request.form_fields = form_fields begin diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md index e45a426f5..1cbbe9af8 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md @@ -11,7 +11,6 @@ | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | | @@ -32,4 +31,5 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/TemplateCreateRequest.md b/sdks/ruby/docs/TemplateCreateRequest.md index bef420aa6..a64d9eff8 100644 --- a/sdks/ruby/docs/TemplateCreateRequest.md +++ b/sdks/ruby/docs/TemplateCreateRequest.md @@ -11,7 +11,6 @@ | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request | | | `client_id` | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | | @@ -25,4 +24,5 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/TemplateResponse.md b/sdks/ruby/docs/TemplateResponse.md index 234a2ee25..24e48f696 100644 --- a/sdks/ruby/docs/TemplateResponse.md +++ b/sdks/ruby/docs/TemplateResponse.md @@ -22,5 +22,5 @@ Contains information about the templates you and your team have created. | `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments` | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | | +| `signer_experience` | [```SignatureRequestSignerExperience```](SignatureRequestSignerExperience.md) | | | diff --git a/sdks/ruby/docs/TemplateUpdateRequest.md b/sdks/ruby/docs/TemplateUpdateRequest.md index 5a7f641d7..d77354142 100644 --- a/sdks/ruby/docs/TemplateUpdateRequest.md +++ b/sdks/ruby/docs/TemplateUpdateRequest.md @@ -7,9 +7,9 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `cc_roles` | ```Array``` | The CC roles that must be assigned when using the template to send a signature request. | | -| `allow_form_view` | ```Boolean``` | The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `subject` | ```String``` | The new default template email subject. | | | `message` | ```String``` | The new default template email message. | | | `form_fields` | [```Array```](SubUpdateFormField.md) | A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md index 7cf4f9a75..47acc3977 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -12,7 +12,6 @@ | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to true] | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md index cd7ffb1ee..dda0a41f7 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md @@ -10,7 +10,6 @@ | `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] | -| `allow_form_view` | ```Boolean``` | Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. | [default to false] | | `attachments` | [```Array```](SubAttachment.md) | A list describing the attachments | | | `cc_email_addresses` | ```Array``` | The email addresses that should be CCed. | | | `client_id` | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | | @@ -31,4 +30,5 @@ | `use_preexisting_fields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `use_text_tags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | +| `signer_experience` | [```SubSignerExperience```](SubSignerExperience.md) | | | diff --git a/sdks/ruby/lib/dropbox-sign.rb b/sdks/ruby/lib/dropbox-sign.rb index 729ebf6c1..0c2c25146 100644 --- a/sdks/ruby/lib/dropbox-sign.rb +++ b/sdks/ruby/lib/dropbox-sign.rb @@ -97,6 +97,7 @@ require 'dropbox-sign/models/signature_request_response_signatures' require 'dropbox-sign/models/signature_request_send_request' require 'dropbox-sign/models/signature_request_send_with_template_request' +require 'dropbox-sign/models/signature_request_signer_experience' require 'dropbox-sign/models/signature_request_update_request' require 'dropbox-sign/models/sub_attachment' require 'dropbox-sign/models/sub_bulk_signer_list' @@ -118,6 +119,7 @@ require 'dropbox-sign/models/sub_signature_request_grouped_signers' require 'dropbox-sign/models/sub_signature_request_signer' require 'dropbox-sign/models/sub_signature_request_template_signer' +require 'dropbox-sign/models/sub_signer_experience' require 'dropbox-sign/models/sub_signing_options' require 'dropbox-sign/models/sub_team_response' require 'dropbox-sign/models/sub_template_role' diff --git a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb index 603f9e568..5c3b2367b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +++ b/sdks/ruby/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb @@ -118,6 +118,9 @@ class BulkSendJobGetResponseSignatureRequests # @return [String] attr_accessor :bulk_send_job_id + # @return [SignatureRequestSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -145,7 +148,8 @@ def self.attribute_map :'attachments' => :'attachments', :'response_data' => :'response_data', :'signatures' => :'signatures', - :'bulk_send_job_id' => :'bulk_send_job_id' + :'bulk_send_job_id' => :'bulk_send_job_id', + :'signer_experience' => :'signer_experience' } end @@ -186,7 +190,8 @@ def self.openapi_types :'attachments' => :'Array', :'response_data' => :'Array', :'signatures' => :'Array', - :'bulk_send_job_id' => :'String' + :'bulk_send_job_id' => :'String', + :'signer_experience' => :'SignatureRequestSignerExperience' } end @@ -363,6 +368,10 @@ def initialize(attributes = {}) if attributes.key?(:'bulk_send_job_id') self.bulk_send_job_id = attributes[:'bulk_send_job_id'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -407,7 +416,8 @@ def ==(o) attachments == o.attachments && response_data == o.response_data && signatures == o.signatures && - bulk_send_job_id == o.bulk_send_job_id + bulk_send_job_id == o.bulk_send_job_id && + signer_experience == o.signer_experience end # @see the `==` method @@ -419,7 +429,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash + [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb index 64667e5f8..31a4dbf65 100644 --- a/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/embedded_edit_url_request.rb @@ -22,10 +22,6 @@ class EmbeddedEditUrlRequest # @return [Boolean] attr_accessor :allow_edit_ccs - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. # @return [Array] attr_accessor :cc_roles @@ -61,11 +57,13 @@ class EmbeddedEditUrlRequest # @return [Boolean] attr_accessor :test_mode + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'allow_edit_ccs' => :'allow_edit_ccs', - :'allow_form_view' => :'allow_form_view', :'cc_roles' => :'cc_roles', :'editor_options' => :'editor_options', :'force_signer_roles' => :'force_signer_roles', @@ -74,7 +72,8 @@ def self.attribute_map :'preview_only' => :'preview_only', :'show_preview' => :'show_preview', :'show_progress_stepper' => :'show_progress_stepper', - :'test_mode' => :'test_mode' + :'test_mode' => :'test_mode', + :'signer_experience' => :'signer_experience' } end @@ -92,7 +91,6 @@ def self.acceptable_attributes def self.openapi_types { :'allow_edit_ccs' => :'Boolean', - :'allow_form_view' => :'Boolean', :'cc_roles' => :'Array', :'editor_options' => :'SubEditorOptions', :'force_signer_roles' => :'Boolean', @@ -101,7 +99,8 @@ def self.openapi_types :'preview_only' => :'Boolean', :'show_preview' => :'Boolean', :'show_progress_stepper' => :'Boolean', - :'test_mode' => :'Boolean' + :'test_mode' => :'Boolean', + :'signer_experience' => :'SubSignerExperience' } end @@ -158,12 +157,6 @@ def initialize(attributes = {}) self.allow_edit_ccs = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'cc_roles') if (value = attributes[:'cc_roles']).is_a?(Array) self.cc_roles = value @@ -215,6 +208,10 @@ def initialize(attributes = {}) else self.test_mode = false end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -236,7 +233,6 @@ def ==(o) return true if self.equal?(o) self.class == o.class && allow_edit_ccs == o.allow_edit_ccs && - allow_form_view == o.allow_form_view && cc_roles == o.cc_roles && editor_options == o.editor_options && force_signer_roles == o.force_signer_roles && @@ -245,7 +241,8 @@ def ==(o) preview_only == o.preview_only && show_preview == o.show_preview && show_progress_stepper == o.show_progress_stepper && - test_mode == o.test_mode + test_mode == o.test_mode && + signer_experience == o.signer_experience end # @see the `==` method @@ -257,7 +254,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [allow_edit_ccs, allow_form_view, cc_roles, editor_options, force_signer_roles, force_subject_message, merge_fields, preview_only, show_preview, show_progress_stepper, test_mode].hash + [allow_edit_ccs, cc_roles, editor_options, force_signer_roles, force_subject_message, merge_fields, preview_only, show_preview, show_progress_stepper, test_mode, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb index a8f371136..b76f5c763 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb @@ -42,10 +42,6 @@ class SignatureRequestCreateEmbeddedRequest # @return [Boolean] attr_accessor :allow_decline - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. # @return [Boolean] attr_accessor :allow_reassign @@ -112,6 +108,9 @@ class SignatureRequestCreateEmbeddedRequest # @return [Boolean] attr_accessor :populate_auto_fill_fields + # @return [SubSignerExperience] + attr_accessor :signer_experience + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. # @return [Integer, nil] attr_accessor :expires_at @@ -125,7 +124,6 @@ def self.attribute_map :'signers' => :'signers', :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', - :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -143,6 +141,7 @@ def self.attribute_map :'title' => :'title', :'use_text_tags' => :'use_text_tags', :'populate_auto_fill_fields' => :'populate_auto_fill_fields', + :'signer_experience' => :'signer_experience', :'expires_at' => :'expires_at' } end @@ -166,7 +165,6 @@ def self.openapi_types :'signers' => :'Array', :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', - :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -184,6 +182,7 @@ def self.openapi_types :'title' => :'String', :'use_text_tags' => :'Boolean', :'populate_auto_fill_fields' => :'Boolean', + :'signer_experience' => :'SubSignerExperience', :'expires_at' => :'Integer' } end @@ -270,12 +269,6 @@ def initialize(attributes = {}) self.allow_decline = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -368,6 +361,10 @@ def initialize(attributes = {}) self.populate_auto_fill_fields = false end + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end + if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end @@ -463,7 +460,6 @@ def ==(o) signers == o.signers && grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && - allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -481,6 +477,7 @@ def ==(o) title == o.title && use_text_tags == o.use_text_tags && populate_auto_fill_fields == o.populate_auto_fill_fields && + signer_experience == o.signer_experience && expires_at == o.expires_at end @@ -493,7 +490,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, signer_experience, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb index 8fdc7b267..af284bc6e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb @@ -77,6 +77,9 @@ class SignatureRequestCreateEmbeddedWithTemplateRequest # @return [Boolean] attr_accessor :populate_auto_fill_fields + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -94,7 +97,8 @@ def self.attribute_map :'subject' => :'subject', :'test_mode' => :'test_mode', :'title' => :'title', - :'populate_auto_fill_fields' => :'populate_auto_fill_fields' + :'populate_auto_fill_fields' => :'populate_auto_fill_fields', + :'signer_experience' => :'signer_experience' } end @@ -125,7 +129,8 @@ def self.openapi_types :'subject' => :'String', :'test_mode' => :'Boolean', :'title' => :'String', - :'populate_auto_fill_fields' => :'Boolean' + :'populate_auto_fill_fields' => :'Boolean', + :'signer_experience' => :'SubSignerExperience' } end @@ -255,6 +260,10 @@ def initialize(attributes = {}) else self.populate_auto_fill_fields = false end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -385,7 +394,8 @@ def ==(o) subject == o.subject && test_mode == o.test_mode && title == o.title && - populate_auto_fill_fields == o.populate_auto_fill_fields + populate_auto_fill_fields == o.populate_auto_fill_fields && + signer_experience == o.signer_experience end # @see the `==` method @@ -397,7 +407,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_ids, client_id, signers, allow_decline, ccs, custom_fields, files, file_urls, message, metadata, signing_options, subject, test_mode, title, populate_auto_fill_fields].hash + [template_ids, client_id, signers, allow_decline, ccs, custom_fields, files, file_urls, message, metadata, signing_options, subject, test_mode, title, populate_auto_fill_fields, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb index b6f60f43e..ea15329c2 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb @@ -42,10 +42,6 @@ class SignatureRequestEditEmbeddedRequest # @return [Boolean] attr_accessor :allow_decline - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. # @return [Boolean] attr_accessor :allow_reassign @@ -116,6 +112,9 @@ class SignatureRequestEditEmbeddedRequest # @return [Integer, nil] attr_accessor :expires_at + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -125,7 +124,6 @@ def self.attribute_map :'signers' => :'signers', :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', - :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -143,7 +141,8 @@ def self.attribute_map :'title' => :'title', :'use_text_tags' => :'use_text_tags', :'populate_auto_fill_fields' => :'populate_auto_fill_fields', - :'expires_at' => :'expires_at' + :'expires_at' => :'expires_at', + :'signer_experience' => :'signer_experience' } end @@ -166,7 +165,6 @@ def self.openapi_types :'signers' => :'Array', :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', - :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -184,14 +182,15 @@ def self.openapi_types :'title' => :'String', :'use_text_tags' => :'Boolean', :'populate_auto_fill_fields' => :'Boolean', - :'expires_at' => :'Integer' + :'expires_at' => :'Integer', + :'signer_experience' => :'SubSignerExperience' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'expires_at' + :'expires_at', ]) end @@ -270,12 +269,6 @@ def initialize(attributes = {}) self.allow_decline = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -371,6 +364,10 @@ def initialize(attributes = {}) if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -463,7 +460,6 @@ def ==(o) signers == o.signers && grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && - allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -481,7 +477,8 @@ def ==(o) title == o.title && use_text_tags == o.use_text_tags && populate_auto_fill_fields == o.populate_auto_fill_fields && - expires_at == o.expires_at + expires_at == o.expires_at && + signer_experience == o.signer_experience end # @see the `==` method @@ -493,7 +490,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb index 8bc7d63dc..74458f51d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb @@ -77,6 +77,9 @@ class SignatureRequestEditEmbeddedWithTemplateRequest # @return [Boolean] attr_accessor :populate_auto_fill_fields + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -94,7 +97,8 @@ def self.attribute_map :'subject' => :'subject', :'test_mode' => :'test_mode', :'title' => :'title', - :'populate_auto_fill_fields' => :'populate_auto_fill_fields' + :'populate_auto_fill_fields' => :'populate_auto_fill_fields', + :'signer_experience' => :'signer_experience' } end @@ -125,7 +129,8 @@ def self.openapi_types :'subject' => :'String', :'test_mode' => :'Boolean', :'title' => :'String', - :'populate_auto_fill_fields' => :'Boolean' + :'populate_auto_fill_fields' => :'Boolean', + :'signer_experience' => :'SubSignerExperience' } end @@ -255,6 +260,10 @@ def initialize(attributes = {}) else self.populate_auto_fill_fields = false end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -385,7 +394,8 @@ def ==(o) subject == o.subject && test_mode == o.test_mode && title == o.title && - populate_auto_fill_fields == o.populate_auto_fill_fields + populate_auto_fill_fields == o.populate_auto_fill_fields && + signer_experience == o.signer_experience end # @see the `==` method @@ -397,7 +407,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_ids, client_id, signers, allow_decline, ccs, custom_fields, files, file_urls, message, metadata, signing_options, subject, test_mode, title, populate_auto_fill_fields].hash + [template_ids, client_id, signers, allow_decline, ccs, custom_fields, files, file_urls, message, metadata, signing_options, subject, test_mode, title, populate_auto_fill_fields, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb index 42f3de3fa..4202ce8bb 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb @@ -38,10 +38,6 @@ class SignatureRequestEditRequest # @return [Boolean] attr_accessor :allow_decline - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. # @return [Boolean] attr_accessor :allow_reassign @@ -120,6 +116,9 @@ class SignatureRequestEditRequest # @return [Integer, nil] attr_accessor :expires_at + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -128,7 +127,6 @@ def self.attribute_map :'signers' => :'signers', :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', - :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -148,7 +146,8 @@ def self.attribute_map :'test_mode' => :'test_mode', :'title' => :'title', :'use_text_tags' => :'use_text_tags', - :'expires_at' => :'expires_at' + :'expires_at' => :'expires_at', + :'signer_experience' => :'signer_experience' } end @@ -170,7 +169,6 @@ def self.openapi_types :'signers' => :'Array', :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', - :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -190,14 +188,15 @@ def self.openapi_types :'test_mode' => :'Boolean', :'title' => :'String', :'use_text_tags' => :'Boolean', - :'expires_at' => :'Integer' + :'expires_at' => :'Integer', + :'signer_experience' => :'SubSignerExperience' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'expires_at' + :'expires_at', ]) end @@ -272,12 +271,6 @@ def initialize(attributes = {}) self.allow_decline = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -381,6 +374,10 @@ def initialize(attributes = {}) if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -457,7 +454,6 @@ def ==(o) signers == o.signers && grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && - allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -477,7 +473,8 @@ def ==(o) test_mode == o.test_mode && title == o.title && use_text_tags == o.use_text_tags && - expires_at == o.expires_at + expires_at == o.expires_at && + signer_experience == o.signer_experience end # @see the `==` method @@ -489,7 +486,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [files, file_urls, signers, grouped_signers, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb index ea8f2a943..a7579f880 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb @@ -82,6 +82,9 @@ class SignatureRequestEditWithTemplateRequest # @return [String] attr_accessor :title + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -100,7 +103,8 @@ def self.attribute_map :'signing_redirect_url' => :'signing_redirect_url', :'subject' => :'subject', :'test_mode' => :'test_mode', - :'title' => :'title' + :'title' => :'title', + :'signer_experience' => :'signer_experience' } end @@ -132,7 +136,8 @@ def self.openapi_types :'signing_redirect_url' => :'String', :'subject' => :'String', :'test_mode' => :'Boolean', - :'title' => :'String' + :'title' => :'String', + :'signer_experience' => :'SubSignerExperience' } end @@ -266,6 +271,10 @@ def initialize(attributes = {}) if attributes.key?(:'title') self.title = attributes[:'title'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -382,7 +391,8 @@ def ==(o) signing_redirect_url == o.signing_redirect_url && subject == o.subject && test_mode == o.test_mode && - title == o.title + title == o.title && + signer_experience == o.signer_experience end # @see the `==` method @@ -394,7 +404,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash + [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb index e8bd41887..83d8bea36 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_response.rb @@ -119,6 +119,9 @@ class SignatureRequestResponse # @return [String, nil] attr_accessor :bulk_send_job_id + # @return [SignatureRequestSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -146,7 +149,8 @@ def self.attribute_map :'attachments' => :'attachments', :'response_data' => :'response_data', :'signatures' => :'signatures', - :'bulk_send_job_id' => :'bulk_send_job_id' + :'bulk_send_job_id' => :'bulk_send_job_id', + :'signer_experience' => :'signer_experience' } end @@ -187,7 +191,8 @@ def self.openapi_types :'attachments' => :'Array', :'response_data' => :'Array', :'signatures' => :'Array', - :'bulk_send_job_id' => :'String' + :'bulk_send_job_id' => :'String', + :'signer_experience' => :'SignatureRequestSignerExperience' } end @@ -205,7 +210,7 @@ def self.openapi_nullable :'custom_fields', :'attachments', :'response_data', - :'bulk_send_job_id' + :'bulk_send_job_id', ]) end @@ -365,6 +370,10 @@ def initialize(attributes = {}) if attributes.key?(:'bulk_send_job_id') self.bulk_send_job_id = attributes[:'bulk_send_job_id'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -409,7 +418,8 @@ def ==(o) attachments == o.attachments && response_data == o.response_data && signatures == o.signatures && - bulk_send_job_id == o.bulk_send_job_id + bulk_send_job_id == o.bulk_send_job_id && + signer_experience == o.signer_experience end # @see the `==` method @@ -421,7 +431,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash + [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb index 13c44b53b..9a81ef480 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb @@ -42,10 +42,6 @@ class SignatureRequestSendRequest # @return [Boolean] attr_accessor :allow_reassign - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -124,6 +120,9 @@ class SignatureRequestSendRequest # @return [Integer, nil] attr_accessor :expires_at + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -133,7 +132,6 @@ def self.attribute_map :'grouped_signers' => :'grouped_signers', :'allow_decline' => :'allow_decline', :'allow_reassign' => :'allow_reassign', - :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', :'client_id' => :'client_id', @@ -153,7 +151,8 @@ def self.attribute_map :'test_mode' => :'test_mode', :'title' => :'title', :'use_text_tags' => :'use_text_tags', - :'expires_at' => :'expires_at' + :'expires_at' => :'expires_at', + :'signer_experience' => :'signer_experience' } end @@ -176,7 +175,6 @@ def self.openapi_types :'grouped_signers' => :'Array', :'allow_decline' => :'Boolean', :'allow_reassign' => :'Boolean', - :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', :'client_id' => :'String', @@ -196,14 +194,15 @@ def self.openapi_types :'test_mode' => :'Boolean', :'title' => :'String', :'use_text_tags' => :'Boolean', - :'expires_at' => :'Integer' + :'expires_at' => :'Integer', + :'signer_experience' => :'SubSignerExperience' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'expires_at' + :'expires_at', ]) end @@ -284,12 +283,6 @@ def initialize(attributes = {}) self.allow_reassign = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -393,6 +386,10 @@ def initialize(attributes = {}) if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -470,7 +467,6 @@ def ==(o) grouped_signers == o.grouped_signers && allow_decline == o.allow_decline && allow_reassign == o.allow_reassign && - allow_form_view == o.allow_form_view && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && client_id == o.client_id && @@ -490,7 +486,8 @@ def ==(o) test_mode == o.test_mode && title == o.title && use_text_tags == o.use_text_tags && - expires_at == o.expires_at + expires_at == o.expires_at && + signer_experience == o.signer_experience end # @see the `==` method @@ -502,7 +499,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, allow_form_view, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb index ac2647256..fd737452a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_with_template_request.rb @@ -86,6 +86,9 @@ class SignatureRequestSendWithTemplateRequest # @return [String] attr_accessor :title + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -105,7 +108,8 @@ def self.attribute_map :'signing_redirect_url' => :'signing_redirect_url', :'subject' => :'subject', :'test_mode' => :'test_mode', - :'title' => :'title' + :'title' => :'title', + :'signer_experience' => :'signer_experience' } end @@ -138,7 +142,8 @@ def self.openapi_types :'signing_redirect_url' => :'String', :'subject' => :'String', :'test_mode' => :'Boolean', - :'title' => :'String' + :'title' => :'String', + :'signer_experience' => :'SubSignerExperience' } end @@ -278,6 +283,10 @@ def initialize(attributes = {}) if attributes.key?(:'title') self.title = attributes[:'title'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -395,7 +404,8 @@ def ==(o) signing_redirect_url == o.signing_redirect_url && subject == o.subject && test_mode == o.test_mode && - title == o.title + title == o.title && + signer_experience == o.signer_experience end # @see the `==` method @@ -407,7 +417,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title].hash + [template_ids, signers, allow_decline, ccs, client_id, custom_fields, files, file_urls, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_signer_experience.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_signer_experience.rb new file mode 100644 index 000000000..9f8e11a88 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_signer_experience.rb @@ -0,0 +1,292 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.12.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + # Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + class SignatureRequestSignerExperience + # Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + # @return [String] + attr_accessor :form_view + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'form_view' => :'form_view' + } + end + + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + acceptable_attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'form_view' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SignatureRequestSignerExperience] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SignatureRequestSignerExperience" + ) || SignatureRequestSignerExperience.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SignatureRequestSignerExperience` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SignatureRequestSignerExperience`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'form_view') + self.form_view = attributes[:'form_view'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @form_view.nil? + invalid_properties.push('invalid value for "form_view", form_view cannot be nil.') + end + + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @form_view.nil? + form_view_validator = EnumAttributeValidator.new('String', ["disabled", "enabled", "enabled_by_default", "forced"]) + return false unless form_view_validator.valid?(@form_view) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] form_view Object to be assigned + def form_view=(form_view) + validator = EnumAttributeValidator.new('String', ["disabled", "enabled", "enabled_by_default", "forced"]) + unless validator.valid?(form_view) + fail ArgumentError, "invalid value for \"form_view\", must be one of #{validator.allowable_values}." + end + @form_view = form_view + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + form_view == o.form_view + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [form_view].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_signer_experience.rb b/sdks/ruby/lib/dropbox-sign/models/sub_signer_experience.rb new file mode 100644 index 000000000..38d88bad2 --- /dev/null +++ b/sdks/ruby/lib/dropbox-sign/models/sub_signer_experience.rb @@ -0,0 +1,287 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.12.0 + +=end + +require 'date' +require 'time' + +module Dropbox +end + +module Dropbox::Sign + # Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. + class SubSignerExperience + # Changes the form view setting experienced by the signer. Supported versions are: - `disabled` - Form view is disabled, and the signer cannot change it - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + # @return [String] + attr_accessor :form_view + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'form_view' => :'form_view' + } + end + + # Returns attribute mapping this model knows about + def self.acceptable_attribute_map + attribute_map + end + + # Returns all the JSON keys this model knows about + def self.acceptable_attributes + acceptable_attribute_map.values + end + + # Attribute type mapping. + def self.openapi_types + { + :'form_view' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Returns attribute map of this model + parent + def self.merged_attributes + self.attribute_map + end + + # Attribute type mapping of this model + parent + def self.merged_types + self.openapi_types + end + + # Returns list of attributes with nullable: true of this model + parent + def self.merged_nullable + self.openapi_nullable + end + + # Attempt to instantiate and hydrate a new instance of this class + # @param [Object] data Data to be converted + # @return [SubSignerExperience] + def self.init(data) + ApiClient.default.convert_to_type( + data, + "SubSignerExperience" + ) || SubSignerExperience.new + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::SubSignerExperience` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + acceptable_attribute_map = self.class.acceptable_attribute_map + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.merged_attributes.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::SubSignerExperience`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'form_view') + self.form_view = attributes[:'form_view'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + form_view_validator = EnumAttributeValidator.new('String', ["disabled", "enabled", "enabled_by_default", "forced"]) + return false unless form_view_validator.valid?(@form_view) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] form_view Object to be assigned + def form_view=(form_view) + validator = EnumAttributeValidator.new('String', ["disabled", "enabled", "enabled_by_default", "forced"]) + unless validator.valid?(form_view) + fail ArgumentError, "invalid value for \"form_view\", must be one of #{validator.allowable_values}." + end + @form_view = form_view + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + form_view == o.form_view + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [form_view].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + attribute_map = self.class.merged_attributes + + self.class.merged_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]])) + end + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :Time + Time.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + klass = Dropbox::Sign.const_get(type) + klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash(include_nil = true) + hash = {} + self.class.merged_attributes.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + next unless include_nil + is_nullable = self.class.merged_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value, include_nil) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value, include_nil = true) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v, include_nil) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v, include_nil) } + end + elsif value.respond_to? :to_hash + value.to_hash(include_nil) + else + value + end + end + end +end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb index 88110b218..1518dd495 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb @@ -38,10 +38,6 @@ class TemplateCreateEmbeddedDraftRequest # @return [Boolean] attr_accessor :allow_reassign - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -120,6 +116,9 @@ class TemplateCreateEmbeddedDraftRequest # @return [Boolean] attr_accessor :use_preexisting_fields + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -128,7 +127,6 @@ def self.attribute_map :'file_urls' => :'file_urls', :'allow_ccs' => :'allow_ccs', :'allow_reassign' => :'allow_reassign', - :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_roles' => :'cc_roles', :'editor_options' => :'editor_options', @@ -148,7 +146,8 @@ def self.attribute_map :'subject' => :'subject', :'test_mode' => :'test_mode', :'title' => :'title', - :'use_preexisting_fields' => :'use_preexisting_fields' + :'use_preexisting_fields' => :'use_preexisting_fields', + :'signer_experience' => :'signer_experience' } end @@ -170,7 +169,6 @@ def self.openapi_types :'file_urls' => :'Array', :'allow_ccs' => :'Boolean', :'allow_reassign' => :'Boolean', - :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_roles' => :'Array', :'editor_options' => :'SubEditorOptions', @@ -190,7 +188,8 @@ def self.openapi_types :'subject' => :'String', :'test_mode' => :'Boolean', :'title' => :'String', - :'use_preexisting_fields' => :'Boolean' + :'use_preexisting_fields' => :'Boolean', + :'signer_experience' => :'SubSignerExperience' } end @@ -269,12 +268,6 @@ def initialize(attributes = {}) self.allow_reassign = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -384,6 +377,10 @@ def initialize(attributes = {}) else self.use_preexisting_fields = false end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -460,7 +457,6 @@ def ==(o) file_urls == o.file_urls && allow_ccs == o.allow_ccs && allow_reassign == o.allow_reassign && - allow_form_view == o.allow_form_view && attachments == o.attachments && cc_roles == o.cc_roles && editor_options == o.editor_options && @@ -480,7 +476,8 @@ def ==(o) subject == o.subject && test_mode == o.test_mode && title == o.title && - use_preexisting_fields == o.use_preexisting_fields + use_preexisting_fields == o.use_preexisting_fields && + signer_experience == o.signer_experience end # @see the `==` method @@ -492,7 +489,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, allow_ccs, allow_reassign, allow_form_view, attachments, cc_roles, editor_options, field_options, force_signer_roles, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, merge_fields, message, metadata, show_preview, show_progress_stepper, signer_roles, skip_me_now, subject, test_mode, title, use_preexisting_fields].hash + [client_id, files, file_urls, allow_ccs, allow_reassign, attachments, cc_roles, editor_options, field_options, force_signer_roles, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, merge_fields, message, metadata, show_preview, show_progress_stepper, signer_roles, skip_me_now, subject, test_mode, title, use_preexisting_fields, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb index 0d47159f5..8b9f5ebf5 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb @@ -38,10 +38,6 @@ class TemplateCreateRequest # @return [Boolean] attr_accessor :allow_reassign - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -93,6 +89,9 @@ class TemplateCreateRequest # @return [Boolean] attr_accessor :use_preexisting_fields + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -101,7 +100,6 @@ def self.attribute_map :'files' => :'files', :'file_urls' => :'file_urls', :'allow_reassign' => :'allow_reassign', - :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_roles' => :'cc_roles', :'client_id' => :'client_id', @@ -114,7 +112,8 @@ def self.attribute_map :'subject' => :'subject', :'test_mode' => :'test_mode', :'title' => :'title', - :'use_preexisting_fields' => :'use_preexisting_fields' + :'use_preexisting_fields' => :'use_preexisting_fields', + :'signer_experience' => :'signer_experience' } end @@ -136,7 +135,6 @@ def self.openapi_types :'files' => :'Array', :'file_urls' => :'Array', :'allow_reassign' => :'Boolean', - :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_roles' => :'Array', :'client_id' => :'String', @@ -149,7 +147,8 @@ def self.openapi_types :'subject' => :'String', :'test_mode' => :'Boolean', :'title' => :'String', - :'use_preexisting_fields' => :'Boolean' + :'use_preexisting_fields' => :'Boolean', + :'signer_experience' => :'SubSignerExperience' } end @@ -230,12 +229,6 @@ def initialize(attributes = {}) self.allow_reassign = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -303,6 +296,10 @@ def initialize(attributes = {}) else self.use_preexisting_fields = false end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -394,7 +391,6 @@ def ==(o) files == o.files && file_urls == o.file_urls && allow_reassign == o.allow_reassign && - allow_form_view == o.allow_form_view && attachments == o.attachments && cc_roles == o.cc_roles && client_id == o.client_id && @@ -407,7 +403,8 @@ def ==(o) subject == o.subject && test_mode == o.test_mode && title == o.title && - use_preexisting_fields == o.use_preexisting_fields + use_preexisting_fields == o.use_preexisting_fields && + signer_experience == o.signer_experience end # @see the `==` method @@ -419,7 +416,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [form_fields_per_document, signer_roles, files, file_urls, allow_reassign, allow_form_view, attachments, cc_roles, client_id, field_options, form_field_groups, form_field_rules, merge_fields, message, metadata, subject, test_mode, title, use_preexisting_fields].hash + [form_fields_per_document, signer_roles, files, file_urls, allow_reassign, attachments, cc_roles, client_id, field_options, form_field_groups, form_field_rules, merge_fields, message, metadata, subject, test_mode, title, use_preexisting_fields, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_response.rb index a6dcfa1f9..82bddb143 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response.rb @@ -83,9 +83,8 @@ class TemplateResponse # @return [Array] attr_accessor :attachments - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view + # @return [SignatureRequestSignerExperience] + attr_accessor :signer_experience # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map @@ -106,7 +105,7 @@ def self.attribute_map :'named_form_fields' => :'named_form_fields', :'accounts' => :'accounts', :'attachments' => :'attachments', - :'allow_form_view' => :'allow_form_view' + :'signer_experience' => :'signer_experience' } end @@ -139,7 +138,7 @@ def self.openapi_types :'named_form_fields' => :'Array', :'accounts' => :'Array', :'attachments' => :'Array', - :'allow_form_view' => :'Boolean' + :'signer_experience' => :'SignatureRequestSignerExperience' } end @@ -273,8 +272,8 @@ def initialize(attributes = {}) end end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] end end @@ -312,7 +311,7 @@ def ==(o) named_form_fields == o.named_form_fields && accounts == o.accounts && attachments == o.attachments && - allow_form_view == o.allow_form_view + signer_experience == o.signer_experience end # @see the `==` method @@ -324,7 +323,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_id, title, message, updated_at, is_embedded, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, custom_fields, named_form_fields, accounts, attachments, allow_form_view].hash + [template_id, title, message, updated_at, is_embedded, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, custom_fields, named_form_fields, accounts, attachments, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_update_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_update_request.rb index 0578713b1..b22dba191 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_update_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_update_request.rb @@ -22,10 +22,6 @@ class TemplateUpdateRequest # @return [Array] attr_accessor :cc_roles - # The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names. - # @return [Boolean] - attr_accessor :allow_form_view - # The title you want to assign to the SignatureRequest. # @return [String] attr_accessor :title @@ -42,15 +38,18 @@ class TemplateUpdateRequest # @return [Array] attr_accessor :form_fields + # @return [SubSignerExperience] + attr_accessor :signer_experience + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'cc_roles' => :'cc_roles', - :'allow_form_view' => :'allow_form_view', :'title' => :'title', :'subject' => :'subject', :'message' => :'message', - :'form_fields' => :'form_fields' + :'form_fields' => :'form_fields', + :'signer_experience' => :'signer_experience' } end @@ -68,11 +67,11 @@ def self.acceptable_attributes def self.openapi_types { :'cc_roles' => :'Array', - :'allow_form_view' => :'Boolean', :'title' => :'String', :'subject' => :'String', :'message' => :'String', - :'form_fields' => :'Array' + :'form_fields' => :'Array', + :'signer_experience' => :'SubSignerExperience' } end @@ -129,10 +128,6 @@ def initialize(attributes = {}) end end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - end - if attributes.key?(:'title') self.title = attributes[:'title'] end @@ -150,6 +145,10 @@ def initialize(attributes = {}) self.form_fields = value end end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -201,11 +200,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && cc_roles == o.cc_roles && - allow_form_view == o.allow_form_view && title == o.title && subject == o.subject && message == o.message && - form_fields == o.form_fields + form_fields == o.form_fields && + signer_experience == o.signer_experience end # @see the `==` method @@ -217,7 +216,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [cc_roles, allow_form_view, title, subject, message, form_fields].hash + [cc_roles, title, subject, message, form_fields, signer_experience].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb index 9d0495a59..210aae825 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb @@ -43,10 +43,6 @@ class UnclaimedDraftCreateEmbeddedRequest # @return [Boolean] attr_accessor :allow_decline - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. # @return [Boolean] attr_accessor :allow_reassign @@ -195,7 +191,6 @@ def self.attribute_map :'file_urls' => :'file_urls', :'allow_ccs' => :'allow_ccs', :'allow_decline' => :'allow_decline', - :'allow_form_view' => :'allow_form_view', :'allow_reassign' => :'allow_reassign', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', @@ -248,7 +243,6 @@ def self.openapi_types :'file_urls' => :'Array', :'allow_ccs' => :'Boolean', :'allow_decline' => :'Boolean', - :'allow_form_view' => :'Boolean', :'allow_reassign' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', @@ -362,12 +356,6 @@ def initialize(attributes = {}) self.allow_decline = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'allow_reassign') self.allow_reassign = attributes[:'allow_reassign'] else @@ -633,7 +621,6 @@ def ==(o) file_urls == o.file_urls && allow_ccs == o.allow_ccs && allow_decline == o.allow_decline && - allow_form_view == o.allow_form_view && allow_reassign == o.allow_reassign && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && @@ -675,7 +662,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_form_view, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb index 2d8fd3027..daa214b1d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb @@ -35,10 +35,6 @@ class UnclaimedDraftCreateRequest # @return [Boolean] attr_accessor :allow_decline - # Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. - # @return [Boolean] - attr_accessor :allow_form_view - # A list describing the attachments # @return [Array] attr_accessor :attachments @@ -117,6 +113,9 @@ class UnclaimedDraftCreateRequest # @return [Integer, nil] attr_accessor :expires_at + # @return [SubSignerExperience] + attr_accessor :signer_experience + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -146,7 +145,6 @@ def self.attribute_map :'files' => :'files', :'file_urls' => :'file_urls', :'allow_decline' => :'allow_decline', - :'allow_form_view' => :'allow_form_view', :'attachments' => :'attachments', :'cc_email_addresses' => :'cc_email_addresses', :'client_id' => :'client_id', @@ -166,7 +164,8 @@ def self.attribute_map :'test_mode' => :'test_mode', :'use_preexisting_fields' => :'use_preexisting_fields', :'use_text_tags' => :'use_text_tags', - :'expires_at' => :'expires_at' + :'expires_at' => :'expires_at', + :'signer_experience' => :'signer_experience' } end @@ -187,7 +186,6 @@ def self.openapi_types :'files' => :'Array', :'file_urls' => :'Array', :'allow_decline' => :'Boolean', - :'allow_form_view' => :'Boolean', :'attachments' => :'Array', :'cc_email_addresses' => :'Array', :'client_id' => :'String', @@ -207,14 +205,15 @@ def self.openapi_types :'test_mode' => :'Boolean', :'use_preexisting_fields' => :'Boolean', :'use_text_tags' => :'Boolean', - :'expires_at' => :'Integer' + :'expires_at' => :'Integer', + :'signer_experience' => :'SubSignerExperience' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'expires_at' + :'expires_at', ]) end @@ -281,12 +280,6 @@ def initialize(attributes = {}) self.allow_decline = false end - if attributes.key?(:'allow_form_view') - self.allow_form_view = attributes[:'allow_form_view'] - else - self.allow_form_view = false - end - if attributes.key?(:'attachments') if (value = attributes[:'attachments']).is_a?(Array) self.attachments = value @@ -392,6 +385,10 @@ def initialize(attributes = {}) if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end + + if attributes.key?(:'signer_experience') + self.signer_experience = attributes[:'signer_experience'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -469,7 +466,6 @@ def ==(o) files == o.files && file_urls == o.file_urls && allow_decline == o.allow_decline && - allow_form_view == o.allow_form_view && attachments == o.attachments && cc_email_addresses == o.cc_email_addresses && client_id == o.client_id && @@ -489,7 +485,8 @@ def ==(o) test_mode == o.test_mode && use_preexisting_fields == o.use_preexisting_fields && use_text_tags == o.use_text_tags && - expires_at == o.expires_at + expires_at == o.expires_at && + signer_experience == o.signer_experience end # @see the `==` method @@ -501,7 +498,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, files, file_urls, allow_decline, allow_form_view, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, show_progress_stepper, signers, signing_options, signing_redirect_url, subject, test_mode, use_preexisting_fields, use_text_tags, expires_at].hash + [type, files, file_urls, allow_decline, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, show_progress_stepper, signers, signing_options, signing_redirect_url, subject, test_mode, use_preexisting_fields, use_text_tags, expires_at, signer_experience].hash end # Builds the object from hash diff --git a/test_fixtures/EmbeddedEditUrlRequest.json b/test_fixtures/EmbeddedEditUrlRequest.json index 0d14a76a8..238279f1b 100644 --- a/test_fixtures/EmbeddedEditUrlRequest.json +++ b/test_fixtures/EmbeddedEditUrlRequest.json @@ -1,7 +1,9 @@ { "default": { "allow_edit_ccs": true, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "cc_roles": [ "" ], diff --git a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json index b0b488f04..1f506686a 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json @@ -1,7 +1,9 @@ { "default": { "allow_decline": true, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "allow_reassign": true, "attachments": [ { @@ -126,7 +128,9 @@ }, "with_grouped_signers": { "allow_decline": true, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "allow_reassign": true, "attachments": [ { diff --git a/test_fixtures/SignatureRequestGetResponse.json b/test_fixtures/SignatureRequestGetResponse.json index f0fda3c1c..823286014 100644 --- a/test_fixtures/SignatureRequestGetResponse.json +++ b/test_fixtures/SignatureRequestGetResponse.json @@ -150,6 +150,9 @@ "lawyer@dropboxsign.com", "lawyer@example.com" ], + "signer_experience": { + "form_view": "disabled" + }, "test_mode": false } } diff --git a/test_fixtures/SignatureRequestSendRequest.json b/test_fixtures/SignatureRequestSendRequest.json index fc1d1f27a..cfc2f4f33 100644 --- a/test_fixtures/SignatureRequestSendRequest.json +++ b/test_fixtures/SignatureRequestSendRequest.json @@ -1,7 +1,9 @@ { "default": { "allow_decline": true, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "allow_reassign": true, "attachments": [ { @@ -240,7 +242,9 @@ }, "with_grouped_signers": { "allow_decline": true, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "allow_reassign": true, "attachments": [ { diff --git a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json index c154ef1a1..0dd7c633c 100644 --- a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +++ b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json @@ -1,7 +1,9 @@ { "default": { "allow_ccs": true, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "allow_reassign": true, "attachments": [ { diff --git a/test_fixtures/TemplateGetResponse.json b/test_fixtures/TemplateGetResponse.json index a80b24c1a..e3608ac4f 100644 --- a/test_fixtures/TemplateGetResponse.json +++ b/test_fixtures/TemplateGetResponse.json @@ -9,7 +9,9 @@ "is_creator": true, "is_embedded": false, "is_locked": false, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "metadata": { "metadata_name_1": "metadata_value_1", "metadata_name_2": { diff --git a/test_fixtures/TemplateListResponse.json b/test_fixtures/TemplateListResponse.json index f43ff3ec0..6b86496ca 100644 --- a/test_fixtures/TemplateListResponse.json +++ b/test_fixtures/TemplateListResponse.json @@ -16,7 +16,9 @@ "is_creator": true, "is_embedded": false, "is_locked": false, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "metadata": { "metadata_name_1": "metadata_value_1", "metadata_name_2": { @@ -98,7 +100,9 @@ "is_creator": true, "is_embedded": false, "is_locked": false, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "metadata": {}, "signer_roles": [ { diff --git a/test_fixtures/TemplateUpdateRequest.json b/test_fixtures/TemplateUpdateRequest.json index 26ae3711b..5dceb47fb 100644 --- a/test_fixtures/TemplateUpdateRequest.json +++ b/test_fixtures/TemplateUpdateRequest.json @@ -1,6 +1,8 @@ { "default": { - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "title": "Test Title", "subject": "Test Subject", "message": "Test Message", diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json index 6949f32da..e18890b74 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json @@ -1,7 +1,6 @@ { "default": { "allow_ccs": true, - "allow_form_view": false, "allow_decline": true, "allow_reassign": true, "attachments": [ diff --git a/test_fixtures/UnclaimedDraftCreateRequest.json b/test_fixtures/UnclaimedDraftCreateRequest.json index 649c3553a..56aa4a024 100644 --- a/test_fixtures/UnclaimedDraftCreateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateRequest.json @@ -1,7 +1,9 @@ { "default": { "allow_decline": true, - "allow_form_view": false, + "signer_experience": { + "form_view": "disabled" + }, "attachments": [ { "name": "Attachment1", diff --git a/translations/en.yaml b/translations/en.yaml index 54283f924..e55dda5ab 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1199,6 +1199,7 @@ If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). +"SignatureRequestSignerExperience::DESCRIPTION": Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. "Sub::SignatureRequestTemplateSigner::DESCRIPTION": Add Signers to your Templated-based Signature Request. "Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS": The email address of the signer. "Sub::SignatureRequestTemplateSigner::NAME": The name of the signer. @@ -1218,6 +1219,14 @@ If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). +"Sub::SignerExperience::DESCRIPTION": Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. +"Sub::SignerExperience::DEFAULT": |- + Changes the form view setting experienced by the signer. Supported versions are: + - `disabled` - Form view is disabled, and the signer cannot change it + - `enabled` - Form view is disabled initially, the signer can turn it on using a toggle + - `enabled_by_default` - Form view is enabled initially. The signer car turn it off using a toggle + - `forced` - Form view is enabled initially. The signer cannot change it, the toggle is hidden. + "Sub::SignerRole::NAME": The role name of the signer that will be displayed when the template is used to create a signature request. "Sub::SignerRole::ORDER": The order in which this signer role is required to sign.