From de98af0dbe7f18686507518f76b93d2f7909de3f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20W=C3=B3jcik?= Date: Tue, 9 Dec 2025 08:39:48 +0100 Subject: [PATCH] Add force_advanced_signature_details flag to SubSigningOptions and update OpenAPI & SDKs --- .../SignatureRequestCreateEmbeddedExample.cs | 3 +- ...SignatureRequestCreateEmbeddedExample.java | 1 + .../SignatureRequestCreateEmbeddedExample.php | 3 +- .../SignatureRequestCreateEmbeddedExample.py | 1 + .../SignatureRequestCreateEmbeddedExample.rb | 1 + .../SignatureRequestCreateEmbeddedExample.sh | 1 + .../SignatureRequestCreateEmbeddedExample.ts | 1 + ...equestCreateEmbeddedWithTemplateExample.cs | 3 +- ...uestCreateEmbeddedWithTemplateExample.java | 1 + ...questCreateEmbeddedWithTemplateExample.php | 3 +- ...equestCreateEmbeddedWithTemplateExample.py | 1 + ...equestCreateEmbeddedWithTemplateExample.rb | 1 + ...equestCreateEmbeddedWithTemplateExample.sh | 1 + ...equestCreateEmbeddedWithTemplateExample.ts | 1 + examples/SignatureRequestSendExample.cs | 3 +- examples/SignatureRequestSendExample.java | 1 + examples/SignatureRequestSendExample.php | 3 +- examples/SignatureRequestSendExample.py | 1 + examples/SignatureRequestSendExample.rb | 1 + examples/SignatureRequestSendExample.sh | 1 + examples/SignatureRequestSendExample.ts | 1 + ...SignatureRequestSendWithTemplateExample.cs | 3 +- ...gnatureRequestSendWithTemplateExample.java | 1 + ...ignatureRequestSendWithTemplateExample.php | 3 +- ...SignatureRequestSendWithTemplateExample.py | 1 + ...SignatureRequestSendWithTemplateExample.rb | 1 + ...SignatureRequestSendWithTemplateExample.sh | 1 + ...SignatureRequestSendWithTemplateExample.ts | 1 + ...SignatureRequestCreateEmbeddedRequest.json | 3 +- ...uestCreateEmbeddedWithTemplateRequest.json | 3 +- .../json/SignatureRequestSendRequest.json | 3 +- ...gnatureRequestSendWithTemplateRequest.json | 3 +- openapi-raw.yaml | 11 +++ openapi-sdk.yaml | 15 +++- openapi.yaml | 8 ++- .../SignatureRequestCreateEmbeddedExample.cs | 3 +- ...equestCreateEmbeddedWithTemplateExample.cs | 3 +- .../SignatureRequestSendExample.cs | 3 +- ...SignatureRequestSendWithTemplateExample.cs | 3 +- ...SignatureRequestCreateEmbeddedExample.java | 1 + ...uestCreateEmbeddedWithTemplateExample.java | 1 + .../SignatureRequestSendExample.java | 1 + ...gnatureRequestSendWithTemplateExample.java | 1 + .../SignatureRequestCreateEmbeddedExample.ts | 1 + ...equestCreateEmbeddedWithTemplateExample.ts | 1 + .../node/src/SignatureRequestSendExample.ts | 1 + ...SignatureRequestSendWithTemplateExample.ts | 1 + .../SignatureRequestCreateEmbeddedExample.php | 3 +- ...questCreateEmbeddedWithTemplateExample.php | 3 +- .../php/src/SignatureRequestSendExample.php | 3 +- ...ignatureRequestSendWithTemplateExample.php | 3 +- .../SignatureRequestCreateEmbeddedExample.py | 1 + ...equestCreateEmbeddedWithTemplateExample.py | 1 + .../python/src/SignatureRequestSendExample.py | 1 + ...SignatureRequestSendWithTemplateExample.py | 1 + .../SignatureRequestCreateEmbeddedExample.rb | 1 + ...equestCreateEmbeddedWithTemplateExample.rb | 1 + .../ruby/src/SignatureRequestSendExample.rb | 1 + ...SignatureRequestSendWithTemplateExample.rb | 1 + sdks/dotnet/docs/SignatureRequestApi.md | 12 ++-- sdks/dotnet/docs/SubSigningOptions.md | 4 +- sdks/dotnet/docs/TemplateApi.md | 5 +- .../src/Dropbox.Sign/Api/TemplateApi.cs | 36 +++++++--- .../Dropbox.Sign/Model/SubSigningOptions.cs | 26 ++++++- sdks/java-v1/docs/SignatureRequestApi.md | 4 ++ sdks/java-v1/docs/SubSigningOptions.md | 5 +- sdks/java-v1/docs/TemplateApi.md | 3 +- .../com/dropbox/sign/api/TemplateApi.java | 33 +++++++-- .../dropbox/sign/model/SubSigningOptions.java | 72 +++++++++++++++++-- sdks/java-v2/docs/SignatureRequestApi.md | 4 ++ sdks/java-v2/docs/SubSigningOptions.md | 5 +- sdks/java-v2/docs/TemplateApi.md | 3 +- .../com/dropbox/sign/api/TemplateApi.java | 32 ++++++++- .../dropbox/sign/model/SubSigningOptions.java | 59 +++++++++++++-- sdks/node/api/templateApi.ts | 9 +++ sdks/node/dist/api.js | 18 ++++- sdks/node/docs/api/SignatureRequestApi.md | 4 ++ sdks/node/docs/api/TemplateApi.md | 3 +- sdks/node/docs/model/SubSigningOptions.md | 5 +- sdks/node/model/subSigningOptions.ts | 11 ++- sdks/node/types/api/templateApi.d.ts | 2 +- sdks/node/types/model/subSigningOptions.d.ts | 1 + sdks/php/README.md | 2 +- sdks/php/VERSION | 2 +- sdks/php/docs/Api/SignatureRequestApi.md | 12 ++-- sdks/php/docs/Api/TemplateApi.md | 3 +- sdks/php/docs/Model/SubSigningOptions.md | 5 +- sdks/php/openapi-config.yaml | 2 +- sdks/php/src/Api/TemplateApi.php | 51 ++++++++----- sdks/php/src/Configuration.php | 4 +- sdks/php/src/Model/SubSigningOptions.php | 36 +++++++++- sdks/python/docs/SignatureRequestApi.md | 4 ++ sdks/python/docs/SubSigningOptions.md | 5 +- sdks/python/docs/TemplateApi.md | 1 + sdks/python/dropbox_sign/api/template_api.py | 32 ++++++++- .../models/sub_signing_options.py | 13 +++- sdks/ruby/docs/SignatureRequestApi.md | 4 ++ sdks/ruby/docs/SubSigningOptions.md | 5 +- sdks/ruby/docs/TemplateApi.md | 7 +- .../ruby/lib/dropbox-sign/api/template_api.rb | 3 + .../models/sub_signing_options.rb | 23 ++++-- ...SignatureRequestCreateEmbeddedRequest.json | 6 +- ...uestCreateEmbeddedWithTemplateRequest.json | 3 +- .../SignatureRequestSendRequest.json | 6 +- ...gnatureRequestSendWithTemplateRequest.json | 3 +- .../UnclaimedDraftCreateEmbeddedRequest.json | 3 +- ...raftCreateEmbeddedWithTemplateRequest.json | 3 +- .../UnclaimedDraftCreateRequest.json | 3 +- translations/en.yaml | 5 +- 109 files changed, 612 insertions(+), 120 deletions(-) diff --git a/examples/SignatureRequestCreateEmbeddedExample.cs b/examples/SignatureRequestCreateEmbeddedExample.cs index b9e866cce..4cfdff972 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.cs +++ b/examples/SignatureRequestCreateEmbeddedExample.cs @@ -22,7 +22,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false ); var signerExperience = new SubSignerExperience( diff --git a/examples/SignatureRequestCreateEmbeddedExample.java b/examples/SignatureRequestCreateEmbeddedExample.java index c3fbe6976..f36cbd7e9 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.java +++ b/examples/SignatureRequestCreateEmbeddedExample.java @@ -29,6 +29,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); diff --git a/examples/SignatureRequestCreateEmbeddedExample.php b/examples/SignatureRequestCreateEmbeddedExample.php index 95a76666d..95f731502 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.php +++ b/examples/SignatureRequestCreateEmbeddedExample.php @@ -16,7 +16,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); diff --git a/examples/SignatureRequestCreateEmbeddedExample.py b/examples/SignatureRequestCreateEmbeddedExample.py index 982aed695..0e9bc371a 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.py +++ b/examples/SignatureRequestCreateEmbeddedExample.py @@ -16,6 +16,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signer_experience = models.SubSignerExperience( diff --git a/examples/SignatureRequestCreateEmbeddedExample.rb b/examples/SignatureRequestCreateEmbeddedExample.rb index 75ff50551..6252a09c4 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.rb +++ b/examples/SignatureRequestCreateEmbeddedExample.rb @@ -12,6 +12,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signer_experience = Dropbox::Sign::SubSignerExperience.new signer_experience.form_view = "disabled" diff --git a/examples/SignatureRequestCreateEmbeddedExample.sh b/examples/SignatureRequestCreateEmbeddedExample.sh index 1ef8303f3..58b8708aa 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.sh +++ b/examples/SignatureRequestCreateEmbeddedExample.sh @@ -18,4 +18,5 @@ curl -X POST 'https://api.hellosign.com/v3/signature_request/create_embedded' \ -F 'signing_options[upload]=1' \ -F 'signing_options[phone]=1' \ -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ -F 'test_mode=1' diff --git a/examples/SignatureRequestCreateEmbeddedExample.ts b/examples/SignatureRequestCreateEmbeddedExample.ts index 815b0b0e6..cff763e4d 100644 --- a/examples/SignatureRequestCreateEmbeddedExample.ts +++ b/examples/SignatureRequestCreateEmbeddedExample.ts @@ -12,6 +12,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signerExperience: models.SubSignerExperience = { diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs index fc664d969..3e3d26982 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -22,7 +22,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false ); var signerExperience = new SubSignerExperience( diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java index 62b553852..6e957118e 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -29,6 +29,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php index 7c5ca74d7..598636c01 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -16,7 +16,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py index 351f8afa5..ecb367eca 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -16,6 +16,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signer_experience = models.SubSignerExperience( diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb index e66a8e4c2..5f37d4834 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -12,6 +12,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signer_experience = Dropbox::Sign::SubSignerExperience.new signer_experience.form_view = "disabled" diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh index 91e0a48ec..0a247f007 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh @@ -12,4 +12,5 @@ curl -X POST 'https://api.hellosign.com/v3/signature_request/create_embedded_wit -F 'signing_options[upload]=1' \ -F 'signing_options[phone]=1' \ -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ -F 'test_mode=1' diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts index b9ab4c01e..64cfb72d6 100644 --- a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -12,6 +12,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signerExperience: models.SubSignerExperience = { diff --git a/examples/SignatureRequestSendExample.cs b/examples/SignatureRequestSendExample.cs index 2958c264c..d5e8ad896 100644 --- a/examples/SignatureRequestSendExample.cs +++ b/examples/SignatureRequestSendExample.cs @@ -26,7 +26,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false, ); var signers1 = new SubSignatureRequestSigner( diff --git a/examples/SignatureRequestSendExample.java b/examples/SignatureRequestSendExample.java index 313b895b7..7db66e606 100644 --- a/examples/SignatureRequestSendExample.java +++ b/examples/SignatureRequestSendExample.java @@ -32,6 +32,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); diff --git a/examples/SignatureRequestSendExample.php b/examples/SignatureRequestSendExample.php index f922a579e..f8ab05ef0 100644 --- a/examples/SignatureRequestSendExample.php +++ b/examples/SignatureRequestSendExample.php @@ -19,7 +19,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") diff --git a/examples/SignatureRequestSendExample.py b/examples/SignatureRequestSendExample.py index 21b1bfc26..033e973fe 100644 --- a/examples/SignatureRequestSendExample.py +++ b/examples/SignatureRequestSendExample.py @@ -20,6 +20,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signers_1 = models.SubSignatureRequestSigner( diff --git a/examples/SignatureRequestSendExample.rb b/examples/SignatureRequestSendExample.rb index 28905902d..45958b7a3 100644 --- a/examples/SignatureRequestSendExample.rb +++ b/examples/SignatureRequestSendExample.rb @@ -15,6 +15,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" diff --git a/examples/SignatureRequestSendExample.sh b/examples/SignatureRequestSendExample.sh index 089a2c6be..6f1e15a7f 100644 --- a/examples/SignatureRequestSendExample.sh +++ b/examples/SignatureRequestSendExample.sh @@ -19,5 +19,6 @@ curl -X POST 'https://api.hellosign.com/v3/signature_request/send' \ -F 'signing_options[upload]=1' \ -F 'signing_options[phone]=1' \ -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ -F 'field_options[date_format]=DD - MM - YYYY' \ -F 'test_mode=1' diff --git a/examples/SignatureRequestSendExample.ts b/examples/SignatureRequestSendExample.ts index 910a66743..064e68ad3 100644 --- a/examples/SignatureRequestSendExample.ts +++ b/examples/SignatureRequestSendExample.ts @@ -16,6 +16,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signers1: models.SubSignatureRequestSigner = { diff --git a/examples/SignatureRequestSendWithTemplateExample.cs b/examples/SignatureRequestSendWithTemplateExample.cs index 024b92ce8..72d43c3d3 100644 --- a/examples/SignatureRequestSendWithTemplateExample.cs +++ b/examples/SignatureRequestSendWithTemplateExample.cs @@ -22,7 +22,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false, ); var signers1 = new SubSignatureRequestTemplateSigner( diff --git a/examples/SignatureRequestSendWithTemplateExample.java b/examples/SignatureRequestSendWithTemplateExample.java index f44a67ed9..5c6bd8d6b 100644 --- a/examples/SignatureRequestSendWithTemplateExample.java +++ b/examples/SignatureRequestSendWithTemplateExample.java @@ -29,6 +29,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); diff --git a/examples/SignatureRequestSendWithTemplateExample.php b/examples/SignatureRequestSendWithTemplateExample.php index d68205392..747882e76 100644 --- a/examples/SignatureRequestSendWithTemplateExample.php +++ b/examples/SignatureRequestSendWithTemplateExample.php @@ -16,7 +16,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") diff --git a/examples/SignatureRequestSendWithTemplateExample.py b/examples/SignatureRequestSendWithTemplateExample.py index 468a6b101..7c94fedc6 100644 --- a/examples/SignatureRequestSendWithTemplateExample.py +++ b/examples/SignatureRequestSendWithTemplateExample.py @@ -16,6 +16,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signers_1 = models.SubSignatureRequestTemplateSigner( diff --git a/examples/SignatureRequestSendWithTemplateExample.rb b/examples/SignatureRequestSendWithTemplateExample.rb index 4ee78fded..237c12fe5 100644 --- a/examples/SignatureRequestSendWithTemplateExample.rb +++ b/examples/SignatureRequestSendWithTemplateExample.rb @@ -12,6 +12,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" diff --git a/examples/SignatureRequestSendWithTemplateExample.sh b/examples/SignatureRequestSendWithTemplateExample.sh index 520089167..e59ee1b24 100644 --- a/examples/SignatureRequestSendWithTemplateExample.sh +++ b/examples/SignatureRequestSendWithTemplateExample.sh @@ -18,4 +18,5 @@ curl -X POST 'https://api.hellosign.com/v3/signature_request/send_with_template' -F 'signing_options[upload]=1' \ -F 'signing_options[phone]=1' \ -F 'signing_options[default_type]=draw' \ + -F 'signing_options[force_advanced_signature_details]=0' \ -F 'test_mode=1' diff --git a/examples/SignatureRequestSendWithTemplateExample.ts b/examples/SignatureRequestSendWithTemplateExample.ts index 88219107a..d327aec9b 100644 --- a/examples/SignatureRequestSendWithTemplateExample.ts +++ b/examples/SignatureRequestSendWithTemplateExample.ts @@ -12,6 +12,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signers1: models.SubSignatureRequestTemplateSigner = { diff --git a/examples/json/SignatureRequestCreateEmbeddedRequest.json b/examples/json/SignatureRequestCreateEmbeddedRequest.json index 5570d6864..d28f87ac1 100644 --- a/examples/json/SignatureRequestCreateEmbeddedRequest.json +++ b/examples/json/SignatureRequestCreateEmbeddedRequest.json @@ -27,7 +27,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "test_mode": true, "signer_experience": { diff --git a/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json b/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json index 7d5cc961e..d23b790f7 100644 --- a/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json +++ b/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json @@ -17,7 +17,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "test_mode": true, "signer_experience": { diff --git a/examples/json/SignatureRequestSendRequest.json b/examples/json/SignatureRequestSendRequest.json index adfda81ec..96d61af2f 100644 --- a/examples/json/SignatureRequestSendRequest.json +++ b/examples/json/SignatureRequestSendRequest.json @@ -30,7 +30,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "field_options": { "date_format": "DD - MM - YYYY" diff --git a/examples/json/SignatureRequestSendWithTemplateRequest.json b/examples/json/SignatureRequestSendWithTemplateRequest.json index a79d1c35b..5ee34fe05 100644 --- a/examples/json/SignatureRequestSendWithTemplateRequest.json +++ b/examples/json/SignatureRequestSendWithTemplateRequest.json @@ -30,7 +30,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "test_mode": true } diff --git a/openapi-raw.yaml b/openapi-raw.yaml index a66a55e6b..f57f029b2 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -6859,6 +6859,13 @@ paths: schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 + - + name: shallow + in: query + description: '_t__TemplateGet::SHALLOW' + schema: + type: boolean + x-hideOn: doc responses: '200': description: 'successful operation' @@ -9989,6 +9996,10 @@ components: description: '_t__Sub::SigningOptions::UPLOAD' type: boolean default: false + force_advanced_signature_details: + description: '_t__Sub::SigningOptions::FORCE_ADVANCED_SIGNATURE_DETAILS' + type: boolean + default: false type: object SubWhiteLabelingOptions: description: '_t__Sub::WhiteLabelingOptions::DESCRIPTION' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 9a0ffd9bf..8b248520f 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -6929,6 +6929,13 @@ paths: schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 + - + name: shallow + in: query + description: '_t__TemplateGet::SHALLOW' + schema: + type: boolean + x-hideOn: doc responses: '200': description: 'successful operation' @@ -10513,9 +10520,11 @@ components: type: object SubSigningOptions: description: |- - This allows the requester to specify the types allowed for creating a signature. + This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + + **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. required: - default_type properties: @@ -10543,6 +10552,10 @@ components: description: 'Allows uploading the signature' type: boolean default: false + force_advanced_signature_details: + description: 'Turning on advanced signature details for the signature request' + type: boolean + default: false type: object SubWhiteLabelingOptions: description: |- diff --git a/openapi.yaml b/openapi.yaml index 35dd6bdc7..dca59b794 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10376,9 +10376,11 @@ components: type: object SubSigningOptions: description: |- - This allows the requester to specify the types allowed for creating a signature. + This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + + **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. required: - default_type properties: @@ -10406,6 +10408,10 @@ components: description: 'Allows uploading the signature' type: boolean default: false + force_advanced_signature_details: + description: 'Turning on advanced signature details for the signature request' + type: boolean + default: false type: object SubWhiteLabelingOptions: description: |- diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs index b9e866cce..4cfdff972 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs @@ -22,7 +22,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false ); var signerExperience = new SubSignerExperience( diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs index fc664d969..3e3d26982 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -22,7 +22,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false ); var signerExperience = new SubSignerExperience( diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs index 2958c264c..d5e8ad896 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs @@ -26,7 +26,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false, ); var signers1 = new SubSignatureRequestSigner( diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs index 024b92ce8..72d43c3d3 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs @@ -22,7 +22,8 @@ public static void Run() draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false, ); var signers1 = new SubSignatureRequestTemplateSigner( 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 c3fbe6976..f36cbd7e9 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 @@ -29,6 +29,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); 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 62b553852..6e957118e 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 @@ -29,6 +29,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java index 313b895b7..7db66e606 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java @@ -32,6 +32,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java index f44a67ed9..5c6bd8d6b 100644 --- a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java @@ -29,6 +29,7 @@ public static void main(String[] args) signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts index 815b0b0e6..cff763e4d 100644 --- a/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts @@ -12,6 +12,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signerExperience: models.SubSignerExperience = { diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts index b9ab4c01e..64cfb72d6 100644 --- a/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -12,6 +12,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signerExperience: models.SubSignerExperience = { diff --git a/sandbox/node/src/SignatureRequestSendExample.ts b/sandbox/node/src/SignatureRequestSendExample.ts index 910a66743..064e68ad3 100644 --- a/sandbox/node/src/SignatureRequestSendExample.ts +++ b/sandbox/node/src/SignatureRequestSendExample.ts @@ -16,6 +16,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signers1: models.SubSignatureRequestSigner = { diff --git a/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts b/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts index 88219107a..d327aec9b 100644 --- a/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts +++ b/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts @@ -12,6 +12,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signers1: models.SubSignatureRequestTemplateSigner = { diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php index 95a76666d..95f731502 100644 --- a/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php @@ -16,7 +16,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php index 7c5ca74d7..598636c01 100644 --- a/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -16,7 +16,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); diff --git a/sandbox/php/src/SignatureRequestSendExample.php b/sandbox/php/src/SignatureRequestSendExample.php index f922a579e..f8ab05ef0 100644 --- a/sandbox/php/src/SignatureRequestSendExample.php +++ b/sandbox/php/src/SignatureRequestSendExample.php @@ -19,7 +19,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") diff --git a/sandbox/php/src/SignatureRequestSendWithTemplateExample.php b/sandbox/php/src/SignatureRequestSendWithTemplateExample.php index d68205392..747882e76 100644 --- a/sandbox/php/src/SignatureRequestSendWithTemplateExample.php +++ b/sandbox/php/src/SignatureRequestSendWithTemplateExample.php @@ -16,7 +16,8 @@ ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py index 982aed695..0e9bc371a 100644 --- a/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py @@ -16,6 +16,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signer_experience = models.SubSignerExperience( diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py index 351f8afa5..ecb367eca 100644 --- a/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -16,6 +16,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signer_experience = models.SubSignerExperience( diff --git a/sandbox/python/src/SignatureRequestSendExample.py b/sandbox/python/src/SignatureRequestSendExample.py index 21b1bfc26..033e973fe 100644 --- a/sandbox/python/src/SignatureRequestSendExample.py +++ b/sandbox/python/src/SignatureRequestSendExample.py @@ -20,6 +20,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signers_1 = models.SubSignatureRequestSigner( diff --git a/sandbox/python/src/SignatureRequestSendWithTemplateExample.py b/sandbox/python/src/SignatureRequestSendWithTemplateExample.py index 468a6b101..7c94fedc6 100644 --- a/sandbox/python/src/SignatureRequestSendWithTemplateExample.py +++ b/sandbox/python/src/SignatureRequestSendWithTemplateExample.py @@ -16,6 +16,7 @@ phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signers_1 = models.SubSignatureRequestTemplateSigner( diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb index 75ff50551..6252a09c4 100644 --- a/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb @@ -12,6 +12,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signer_experience = Dropbox::Sign::SubSignerExperience.new signer_experience.form_view = "disabled" diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb index e66a8e4c2..5f37d4834 100644 --- a/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -12,6 +12,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signer_experience = Dropbox::Sign::SubSignerExperience.new signer_experience.form_view = "disabled" diff --git a/sandbox/ruby/src/SignatureRequestSendExample.rb b/sandbox/ruby/src/SignatureRequestSendExample.rb index 28905902d..45958b7a3 100644 --- a/sandbox/ruby/src/SignatureRequestSendExample.rb +++ b/sandbox/ruby/src/SignatureRequestSendExample.rb @@ -15,6 +15,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" diff --git a/sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb index 4ee78fded..237c12fe5 100644 --- a/sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb +++ b/sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb @@ -12,6 +12,7 @@ signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" diff --git a/sdks/dotnet/docs/SignatureRequestApi.md b/sdks/dotnet/docs/SignatureRequestApi.md index 025b2005b..d3d402058 100644 --- a/sdks/dotnet/docs/SignatureRequestApi.md +++ b/sdks/dotnet/docs/SignatureRequestApi.md @@ -504,7 +504,8 @@ public class SignatureRequestCreateEmbeddedExample draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false ); var signerExperience = new SubSignerExperience( @@ -652,7 +653,8 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false ); var signerExperience = new SubSignerExperience( @@ -2162,7 +2164,8 @@ public class SignatureRequestSendExample draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false, ); var signers1 = new SubSignatureRequestSigner( @@ -2311,7 +2314,8 @@ public class SignatureRequestSendWithTemplateExample draw: true, phone: false, type: true, - upload: true + upload: true, + force_advanced_signature_details: false, ); var signers1 = new SubSignatureRequestTemplateSigner( diff --git a/sdks/dotnet/docs/SubSigningOptions.md b/sdks/dotnet/docs/SubSigningOptions.md index a65674196..7ae5fa9fb 100644 --- a/sdks/dotnet/docs/SubSigningOptions.md +++ b/sdks/dotnet/docs/SubSigningOptions.md @@ -1,11 +1,11 @@ # Dropbox.Sign.Model.SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**DefaultType** | **string** | The default type shown (limited to the listed types) | **Draw** | **bool** | Allows drawing the signature | [optional] [default to false]**Phone** | **bool** | Allows using a smartphone to email the signature | [optional] [default to false]**Type** | **bool** | Allows typing the signature | [optional] [default to false]**Upload** | **bool** | Allows uploading the signature | [optional] [default to false] +**DefaultType** | **string** | The default type shown (limited to the listed types) | **Draw** | **bool** | Allows drawing the signature | [optional] [default to false]**Phone** | **bool** | Allows using a smartphone to email the signature | [optional] [default to false]**Type** | **bool** | Allows typing the signature | [optional] [default to false]**Upload** | **bool** | Allows uploading the signature | [optional] [default to false]**ForceAdvancedSignatureDetails** | **bool** | Turning on advanced signature details for the signature request | [optional] [default to false] [[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 36247c5ba..10c61a5bf 100644 --- a/sdks/dotnet/docs/TemplateApi.md +++ b/sdks/dotnet/docs/TemplateApi.md @@ -853,7 +853,7 @@ catch (ApiException e) # **TemplateGet** -> TemplateGetResponse TemplateGet (string templateId) +> TemplateGetResponse TemplateGet (string templateId, bool? shallow = null) Get Template @@ -906,7 +906,7 @@ This returns an ApiResponse object which contains the response data, status code try { // Get Template - ApiResponse response = apiInstance.TemplateGetWithHttpInfo(templateId); + ApiResponse response = apiInstance.TemplateGetWithHttpInfo(templateId, shallow); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); Debug.Write("Response Body: " + response.Data); @@ -924,6 +924,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **templateId** | **string** | The id of the Template to retrieve. | | +| **shallow** | **bool?** | _t__TemplateGet::SHALLOW | [optional] | ### Return type diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs index 8ca0ec8ed..d32e25618 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs @@ -202,9 +202,10 @@ public interface ITemplateApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// TemplateGetResponse - TemplateGetResponse TemplateGet(string templateId, int operationIndex = 0); + TemplateGetResponse TemplateGet(string templateId, bool? shallow = default(bool?), int operationIndex = 0); /// /// Get Template @@ -214,9 +215,10 @@ public interface ITemplateApiSync : IApiAccessor /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// ApiResponse of TemplateGetResponse - ApiResponse TemplateGetWithHttpInfo(string templateId, int operationIndex = 0); + ApiResponse TemplateGetWithHttpInfo(string templateId, bool? shallow = default(bool?), int operationIndex = 0); /// /// List Templates /// @@ -519,10 +521,11 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplateGetResponse - System.Threading.Tasks.Task TemplateGetAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task TemplateGetAsync(string templateId, bool? shallow = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// Get Template @@ -532,10 +535,11 @@ public interface ITemplateApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplateGetResponse) - System.Threading.Tasks.Task> TemplateGetWithHttpInfoAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); + System.Threading.Tasks.Task> TemplateGetWithHttpInfoAsync(string templateId, bool? shallow = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// /// List Templates /// @@ -2041,11 +2045,12 @@ public Dropbox.Sign.Client.ApiResponse TemplateFilesAsDataU /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// TemplateGetResponse - public TemplateGetResponse TemplateGet(string templateId, int operationIndex = 0) + public TemplateGetResponse TemplateGet(string templateId, bool? shallow = default(bool?), int operationIndex = 0) { - Dropbox.Sign.Client.ApiResponse localVarResponse = TemplateGetWithHttpInfo(templateId); + Dropbox.Sign.Client.ApiResponse localVarResponse = TemplateGetWithHttpInfo(templateId, shallow); return localVarResponse.Data; } @@ -2054,9 +2059,10 @@ public TemplateGetResponse TemplateGet(string templateId, int operationIndex = 0 /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// ApiResponse of TemplateGetResponse - public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpInfo(string templateId, int operationIndex = 0) + public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpInfo(string templateId, bool? shallow = default(bool?), int operationIndex = 0) { // verify the required parameter 'templateId' is set if (templateId == null) @@ -2087,6 +2093,10 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI } localVarRequestOptions.PathParameters.Add("template_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(templateId)); // path parameter + if (shallow != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "shallow", shallow)); + } localVarRequestOptions.Operation = "TemplateApi.TemplateGet"; localVarRequestOptions.OperationIndex = operationIndex; @@ -2123,12 +2133,13 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of TemplateGetResponse - public async System.Threading.Tasks.Task TemplateGetAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task TemplateGetAsync(string templateId, bool? shallow = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { - Dropbox.Sign.Client.ApiResponse localVarResponse = await TemplateGetWithHttpInfoAsync(templateId, operationIndex, cancellationToken).ConfigureAwait(false); + Dropbox.Sign.Client.ApiResponse localVarResponse = await TemplateGetWithHttpInfoAsync(templateId, shallow, operationIndex, cancellationToken).ConfigureAwait(false); return localVarResponse.Data; } @@ -2137,10 +2148,11 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI /// /// Thrown when fails to make API call /// The id of the Template to retrieve. + /// _t__TemplateGet::SHALLOW (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (TemplateGetResponse) - public async System.Threading.Tasks.Task> TemplateGetWithHttpInfoAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) + public async System.Threading.Tasks.Task> TemplateGetWithHttpInfoAsync(string templateId, bool? shallow = default(bool?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)) { // verify the required parameter 'templateId' is set if (templateId == null) @@ -2172,6 +2184,10 @@ public Dropbox.Sign.Client.ApiResponse TemplateGetWithHttpI } localVarRequestOptions.PathParameters.Add("template_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(templateId)); // path parameter + if (shallow != null) + { + localVarRequestOptions.QueryParameters.Add(Dropbox.Sign.Client.ClientUtils.ParameterToMultiMap("", "shallow", shallow)); + } localVarRequestOptions.Operation = "TemplateApi.TemplateGet"; localVarRequestOptions.OperationIndex = operationIndex; diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs index 03e60af0b..da27f470b 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SubSigningOptions.cs @@ -27,7 +27,7 @@ namespace Dropbox.Sign.Model { /// - /// This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + /// This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. /// [DataContract(Name = "SubSigningOptions")] [JsonObject(ItemNullValueHandling = NullValueHandling.Ignore)] @@ -85,7 +85,8 @@ protected SubSigningOptions() { } /// Allows using a smartphone to email the signature (default to false). /// Allows typing the signature (default to false). /// Allows uploading the signature (default to false). - public SubSigningOptions(DefaultTypeEnum defaultType = default(DefaultTypeEnum), bool draw = false, bool phone = false, bool type = false, bool upload = false) + /// Turning on advanced signature details for the signature request (default to false). + public SubSigningOptions(DefaultTypeEnum defaultType = default(DefaultTypeEnum), bool draw = false, bool phone = false, bool type = false, bool upload = false, bool forceAdvancedSignatureDetails = false) { this.DefaultType = defaultType; @@ -93,6 +94,7 @@ protected SubSigningOptions() { } this.Phone = phone; this.Type = type; this.Upload = upload; + this.ForceAdvancedSignatureDetails = forceAdvancedSignatureDetails; } /// @@ -139,6 +141,13 @@ public static SubSigningOptions Init(string jsonData) [DataMember(Name = "upload", EmitDefaultValue = true)] public bool Upload { get; set; } + /// + /// Turning on advanced signature details for the signature request + /// + /// Turning on advanced signature details for the signature request + [DataMember(Name = "force_advanced_signature_details", EmitDefaultValue = true)] + public bool ForceAdvancedSignatureDetails { get; set; } + /// /// Returns the string presentation of the object /// @@ -152,6 +161,7 @@ public override string ToString() sb.Append(" Phone: ").Append(Phone).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Upload: ").Append(Upload).Append("\n"); + sb.Append(" ForceAdvancedSignatureDetails: ").Append(ForceAdvancedSignatureDetails).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -206,6 +216,10 @@ public bool Equals(SubSigningOptions input) ( this.Upload == input.Upload || this.Upload.Equals(input.Upload) + ) && + ( + this.ForceAdvancedSignatureDetails == input.ForceAdvancedSignatureDetails || + this.ForceAdvancedSignatureDetails.Equals(input.ForceAdvancedSignatureDetails) ); } @@ -223,6 +237,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Phone.GetHashCode(); hashCode = (hashCode * 59) + this.Type.GetHashCode(); hashCode = (hashCode * 59) + this.Upload.GetHashCode(); + hashCode = (hashCode * 59) + this.ForceAdvancedSignatureDetails.GetHashCode(); return hashCode; } } @@ -274,6 +289,13 @@ public List GetOpenApiTypes() Type = "bool", Value = Upload, }); + types.Add(new OpenApiType() + { + Name = "force_advanced_signature_details", + Property = "ForceAdvancedSignatureDetails", + Type = "bool", + Value = ForceAdvancedSignatureDetails, + }); return types; } diff --git a/sdks/java-v1/docs/SignatureRequestApi.md b/sdks/java-v1/docs/SignatureRequestApi.md index 61258f2e4..90685cbf0 100644 --- a/sdks/java-v1/docs/SignatureRequestApi.md +++ b/sdks/java-v1/docs/SignatureRequestApi.md @@ -459,6 +459,7 @@ public class SignatureRequestCreateEmbeddedExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); @@ -583,6 +584,7 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); @@ -1894,6 +1896,7 @@ public class SignatureRequestSendExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); @@ -2020,6 +2023,7 @@ public class SignatureRequestSendWithTemplateExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); diff --git a/sdks/java-v1/docs/SubSigningOptions.md b/sdks/java-v1/docs/SubSigningOptions.md index bca116053..6f419c3a2 100644 --- a/sdks/java-v1/docs/SubSigningOptions.md +++ b/sdks/java-v1/docs/SubSigningOptions.md @@ -2,10 +2,12 @@ # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. +This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. + ## Properties | Name | Type | Description | Notes | @@ -15,6 +17,7 @@ This allows the requester to specify the types allowed for creating a signature. | `phone` | ```Boolean``` | Allows using a smartphone to email the signature | | | `type` | ```Boolean``` | Allows typing the signature | | | `upload` | ```Boolean``` | Allows uploading the signature | | +| `forceAdvancedSignatureDetails` | ```Boolean``` | Turning on advanced signature details for the signature request | | diff --git a/sdks/java-v1/docs/TemplateApi.md b/sdks/java-v1/docs/TemplateApi.md index 1ba2b4773..13a0e25bd 100644 --- a/sdks/java-v1/docs/TemplateApi.md +++ b/sdks/java-v1/docs/TemplateApi.md @@ -735,7 +735,7 @@ public class TemplateFilesAsFileUrlExample ## templateGet -> TemplateGetResponse templateGet(templateId) +> TemplateGetResponse templateGet(templateId, shallow) Get Template @@ -794,6 +794,7 @@ public class TemplateGetExample | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **templateId** | **String**| The id of the Template to retrieve. | + **shallow** | **Boolean**| _t__TemplateGet::SHALLOW | [optional] ### Return type diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/TemplateApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/TemplateApi.java index e6547c390..31d5e4fbc 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/TemplateApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/TemplateApi.java @@ -664,6 +664,7 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo( * Get Template Returns the Template specified by the `template_id` parameter. * * @param templateId The id of the Template to retrieve. (required) + * @param shallow _t__TemplateGet::SHALLOW (optional) * @return TemplateGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -674,14 +675,34 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo( * 4XX failed_operation - * */ + public TemplateGetResponse templateGet(String templateId, Boolean shallow) throws ApiException { + return templateGetWithHttpInfo(templateId, shallow).getData(); + } + + /** + * @see TemplateApi#templateGet(String, Boolean) + */ public TemplateGetResponse templateGet(String templateId) throws ApiException { - return templateGetWithHttpInfo(templateId).getData(); + Boolean shallow = null; + + return templateGetWithHttpInfo(templateId, shallow).getData(); + } + + /** + * @see TemplateApi#templateGetWithHttpInfo(String, Boolean) + */ + public ApiResponse templateGetWithHttpInfo(String templateId) + throws ApiException { + Boolean shallow = null; + + return templateGetWithHttpInfo(templateId, shallow); } /** * Get Template Returns the Template specified by the `template_id` parameter. * * @param templateId The id of the Template to retrieve. (required) + * @param shallow _t__TemplateGet::SHALLOW (optional) * @return ApiResponse<TemplateGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -692,8 +713,8 @@ public TemplateGetResponse templateGet(String templateId) throws ApiException { * 4XX failed_operation - * */ - public ApiResponse templateGetWithHttpInfo(String templateId) - throws ApiException { + public ApiResponse templateGetWithHttpInfo( + String templateId, Boolean shallow) throws ApiException { // Check required parameters if (templateId == null) { @@ -707,6 +728,10 @@ public ApiResponse templateGetWithHttpInfo(String templateI .replaceAll( "\\{template_id}", apiClient.escapeString(templateId.toString())); + // Query parameters + List localVarQueryParams = + new ArrayList<>(apiClient.parameterToPairs("", "shallow", shallow)); + String localVarAccept = apiClient.selectHeaderAccept("application/json"); Map localVarFormParams = new LinkedHashMap<>(); localVarFormParams = new HashMap(); @@ -720,7 +745,7 @@ public ApiResponse templateGetWithHttpInfo(String templateI "TemplateApi.templateGet", localVarPath, "GET", - new ArrayList<>(), + localVarQueryParams, null, new LinkedHashMap<>(), new LinkedHashMap<>(), diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java index 0dea6a670..6b9c493da 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SubSigningOptions.java @@ -26,16 +26,18 @@ import java.util.Objects; /** - * This allows the requester to specify the types allowed for creating a signature. **NOTE:** If - * `signing_options` are not defined in the request, the allowed types will default to - * those specified in the account settings. + * This allows the requester to specify the types allowed for creating a signature and specify + * another signing options. **NOTE:** If `signing_options` are not defined in the request, + * the allowed types will default to those specified in the account settings. **NOTE:** If + * `force_advanced_signature_details` is set, allowed types has to be defined too. */ @JsonPropertyOrder({ SubSigningOptions.JSON_PROPERTY_DEFAULT_TYPE, SubSigningOptions.JSON_PROPERTY_DRAW, SubSigningOptions.JSON_PROPERTY_PHONE, SubSigningOptions.JSON_PROPERTY_TYPE, - SubSigningOptions.JSON_PROPERTY_UPLOAD + SubSigningOptions.JSON_PROPERTY_UPLOAD, + SubSigningOptions.JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -94,6 +96,10 @@ public static DefaultTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_UPLOAD = "upload"; @javax.annotation.Nullable private Boolean upload = false; + public static final String JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS = + "force_advanced_signature_details"; + @javax.annotation.Nullable private Boolean forceAdvancedSignatureDetails = false; + public SubSigningOptions() {} /** @@ -221,6 +227,30 @@ public void setUpload(@javax.annotation.Nullable Boolean upload) { this.upload = upload; } + public SubSigningOptions forceAdvancedSignatureDetails( + @javax.annotation.Nullable Boolean forceAdvancedSignatureDetails) { + this.forceAdvancedSignatureDetails = forceAdvancedSignatureDetails; + return this; + } + + /** + * Turning on advanced signature details for the signature request + * + * @return forceAdvancedSignatureDetails + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getForceAdvancedSignatureDetails() { + return forceAdvancedSignatureDetails; + } + + @JsonProperty(JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setForceAdvancedSignatureDetails( + @javax.annotation.Nullable Boolean forceAdvancedSignatureDetails) { + this.forceAdvancedSignatureDetails = forceAdvancedSignatureDetails; + } + /** Return true if this SubSigningOptions object is equal to o. */ @Override public boolean equals(Object o) { @@ -235,12 +265,15 @@ public boolean equals(Object o) { && Objects.equals(this.draw, subSigningOptions.draw) && Objects.equals(this.phone, subSigningOptions.phone) && Objects.equals(this.type, subSigningOptions.type) - && Objects.equals(this.upload, subSigningOptions.upload); + && Objects.equals(this.upload, subSigningOptions.upload) + && Objects.equals( + this.forceAdvancedSignatureDetails, + subSigningOptions.forceAdvancedSignatureDetails); } @Override public int hashCode() { - return Objects.hash(defaultType, draw, phone, type, upload); + return Objects.hash(defaultType, draw, phone, type, upload, forceAdvancedSignatureDetails); } @Override @@ -252,6 +285,9 @@ public String toString() { sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" upload: ").append(toIndentedString(upload)).append("\n"); + sb.append(" forceAdvancedSignatureDetails: ") + .append(toIndentedString(forceAdvancedSignatureDetails)) + .append("\n"); sb.append("}"); return sb.toString(); } @@ -352,6 +388,30 @@ public Map createFormData() throws ApiException { map.put("upload", JSON.getDefault().getMapper().writeValueAsString(upload)); } } + if (forceAdvancedSignatureDetails != null) { + if (isFileTypeOrListOfFiles(forceAdvancedSignatureDetails)) { + fileTypeFound = true; + } + + if (forceAdvancedSignatureDetails.getClass().equals(java.io.File.class) + || forceAdvancedSignatureDetails.getClass().equals(Integer.class) + || forceAdvancedSignatureDetails.getClass().equals(String.class) + || forceAdvancedSignatureDetails.getClass().isEnum()) { + map.put("force_advanced_signature_details", forceAdvancedSignatureDetails); + } else if (isListOfFile(forceAdvancedSignatureDetails)) { + for (int i = 0; i < getListSize(forceAdvancedSignatureDetails); i++) { + map.put( + "force_advanced_signature_details[" + i + "]", + getFromList(forceAdvancedSignatureDetails, i)); + } + } else { + map.put( + "force_advanced_signature_details", + JSON.getDefault() + .getMapper() + .writeValueAsString(forceAdvancedSignatureDetails)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/docs/SignatureRequestApi.md b/sdks/java-v2/docs/SignatureRequestApi.md index 61258f2e4..90685cbf0 100644 --- a/sdks/java-v2/docs/SignatureRequestApi.md +++ b/sdks/java-v2/docs/SignatureRequestApi.md @@ -459,6 +459,7 @@ public class SignatureRequestCreateEmbeddedExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); @@ -583,6 +584,7 @@ public class SignatureRequestCreateEmbeddedWithTemplateExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signerExperience = new SubSignerExperience(); signerExperience.formView(SubSignerExperience.FormViewEnum.DISABLED); @@ -1894,6 +1896,7 @@ public class SignatureRequestSendExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestSigner(); signers1.name("Jack"); @@ -2020,6 +2023,7 @@ public class SignatureRequestSendWithTemplateExample signingOptions.phone(false); signingOptions.type(true); signingOptions.upload(true); + signingOptions.forceAdvancedSignatureDetails(false); var signers1 = new SubSignatureRequestTemplateSigner(); signers1.role("Client"); diff --git a/sdks/java-v2/docs/SubSigningOptions.md b/sdks/java-v2/docs/SubSigningOptions.md index bca116053..6f419c3a2 100644 --- a/sdks/java-v2/docs/SubSigningOptions.md +++ b/sdks/java-v2/docs/SubSigningOptions.md @@ -2,10 +2,12 @@ # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. +This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. + ## Properties | Name | Type | Description | Notes | @@ -15,6 +17,7 @@ This allows the requester to specify the types allowed for creating a signature. | `phone` | ```Boolean``` | Allows using a smartphone to email the signature | | | `type` | ```Boolean``` | Allows typing the signature | | | `upload` | ```Boolean``` | Allows uploading the signature | | +| `forceAdvancedSignatureDetails` | ```Boolean``` | Turning on advanced signature details for the signature request | | diff --git a/sdks/java-v2/docs/TemplateApi.md b/sdks/java-v2/docs/TemplateApi.md index 1ba2b4773..13a0e25bd 100644 --- a/sdks/java-v2/docs/TemplateApi.md +++ b/sdks/java-v2/docs/TemplateApi.md @@ -735,7 +735,7 @@ public class TemplateFilesAsFileUrlExample ## templateGet -> TemplateGetResponse templateGet(templateId) +> TemplateGetResponse templateGet(templateId, shallow) Get Template @@ -794,6 +794,7 @@ public class TemplateGetExample | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **templateId** | **String**| The id of the Template to retrieve. | + **shallow** | **Boolean**| _t__TemplateGet::SHALLOW | [optional] ### Return type diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java index 02d92aacd..2421bb484 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/TemplateApi.java @@ -583,6 +583,7 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ * Get Template * Returns the Template specified by the `template_id` parameter. * @param templateId The id of the Template to retrieve. (required) + * @param shallow _t__TemplateGet::SHALLOW (optional) * @return TemplateGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -593,8 +594,27 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ 4XX failed_operation - */ + public TemplateGetResponse templateGet(String templateId, Boolean shallow) throws ApiException { + return templateGetWithHttpInfo(templateId, shallow).getData(); + } + + + /** + * @see TemplateApi#templateGet(String, Boolean) + */ public TemplateGetResponse templateGet(String templateId) throws ApiException { - return templateGetWithHttpInfo(templateId).getData(); + Boolean shallow = null; + + return templateGetWithHttpInfo(templateId, shallow).getData(); + } + + /** + * @see TemplateApi#templateGetWithHttpInfo(String, Boolean) + */ + public ApiResponse templateGetWithHttpInfo(String templateId) throws ApiException { + Boolean shallow = null; + + return templateGetWithHttpInfo(templateId, shallow); } @@ -602,6 +622,7 @@ public TemplateGetResponse templateGet(String templateId) throws ApiException { * Get Template * Returns the Template specified by the `template_id` parameter. * @param templateId The id of the Template to retrieve. (required) + * @param shallow _t__TemplateGet::SHALLOW (optional) * @return ApiResponse<TemplateGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -612,7 +633,7 @@ public TemplateGetResponse templateGet(String templateId) throws ApiException { 4XX failed_operation - */ - public ApiResponse templateGetWithHttpInfo(String templateId) throws ApiException { + public ApiResponse templateGetWithHttpInfo(String templateId, Boolean shallow) throws ApiException { // Check required parameters if (templateId == null) { @@ -623,6 +644,11 @@ public ApiResponse templateGetWithHttpInfo(String templateI String localVarPath = "/template/{template_id}" .replaceAll("\\{template_id}", apiClient.escapeString(templateId.toString())); + // Query parameters + List localVarQueryParams = new ArrayList<>( + apiClient.parameterToPairs("", "shallow", shallow) + ); + String localVarAccept = apiClient.selectHeaderAccept("application/json"); Map localVarFormParams = new LinkedHashMap<>(); localVarFormParams = new HashMap(); @@ -634,7 +660,7 @@ public ApiResponse templateGetWithHttpInfo(String templateI "TemplateApi.templateGet", localVarPath, "GET", - new ArrayList<>(), + localVarQueryParams, null, new LinkedHashMap<>(), new LinkedHashMap<>(), diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java index 8a194e4bf..2fe79900b 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SubSigningOptions.java @@ -30,14 +30,15 @@ import com.dropbox.sign.ApiException; /** - * This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + * This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. */ @JsonPropertyOrder({ SubSigningOptions.JSON_PROPERTY_DEFAULT_TYPE, SubSigningOptions.JSON_PROPERTY_DRAW, SubSigningOptions.JSON_PROPERTY_PHONE, SubSigningOptions.JSON_PROPERTY_TYPE, - SubSigningOptions.JSON_PROPERTY_UPLOAD + SubSigningOptions.JSON_PROPERTY_UPLOAD, + SubSigningOptions.JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -101,6 +102,10 @@ public static DefaultTypeEnum fromValue(String value) { @jakarta.annotation.Nullable private Boolean upload = false; + public static final String JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS = "force_advanced_signature_details"; + @jakarta.annotation.Nullable + private Boolean forceAdvancedSignatureDetails = false; + public SubSigningOptions() { } @@ -244,6 +249,31 @@ public void setUpload(@jakarta.annotation.Nullable Boolean upload) { } + public SubSigningOptions forceAdvancedSignatureDetails(@jakarta.annotation.Nullable Boolean forceAdvancedSignatureDetails) { + this.forceAdvancedSignatureDetails = forceAdvancedSignatureDetails; + return this; + } + + /** + * Turning on advanced signature details for the signature request + * @return forceAdvancedSignatureDetails + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getForceAdvancedSignatureDetails() { + return forceAdvancedSignatureDetails; + } + + + @JsonProperty(JSON_PROPERTY_FORCE_ADVANCED_SIGNATURE_DETAILS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setForceAdvancedSignatureDetails(@jakarta.annotation.Nullable Boolean forceAdvancedSignatureDetails) { + this.forceAdvancedSignatureDetails = forceAdvancedSignatureDetails; + } + + /** * Return true if this SubSigningOptions object is equal to o. */ @@ -260,12 +290,13 @@ public boolean equals(Object o) { Objects.equals(this.draw, subSigningOptions.draw) && Objects.equals(this.phone, subSigningOptions.phone) && Objects.equals(this.type, subSigningOptions.type) && - Objects.equals(this.upload, subSigningOptions.upload); + Objects.equals(this.upload, subSigningOptions.upload) && + Objects.equals(this.forceAdvancedSignatureDetails, subSigningOptions.forceAdvancedSignatureDetails); } @Override public int hashCode() { - return Objects.hash(defaultType, draw, phone, type, upload); + return Objects.hash(defaultType, draw, phone, type, upload, forceAdvancedSignatureDetails); } @Override @@ -277,6 +308,7 @@ public String toString() { sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" upload: ").append(toIndentedString(upload)).append("\n"); + sb.append(" forceAdvancedSignatureDetails: ").append(toIndentedString(forceAdvancedSignatureDetails)).append("\n"); sb.append("}"); return sb.toString(); } @@ -380,6 +412,25 @@ public Map createFormData() throws ApiException { map.put("upload", JSON.getDefault().getMapper().writeValueAsString(upload)); } } + if (forceAdvancedSignatureDetails != null) { + if (isFileTypeOrListOfFiles(forceAdvancedSignatureDetails)) { + fileTypeFound = true; + } + + if (forceAdvancedSignatureDetails.getClass().equals(java.io.File.class) || + forceAdvancedSignatureDetails.getClass().equals(Integer.class) || + forceAdvancedSignatureDetails.getClass().equals(String.class) || + forceAdvancedSignatureDetails.getClass().isEnum()) { + map.put("force_advanced_signature_details", forceAdvancedSignatureDetails); + } else if (isListOfFile(forceAdvancedSignatureDetails)) { + for(int i = 0; i< getListSize(forceAdvancedSignatureDetails); i++) { + map.put("force_advanced_signature_details[" + i + "]", getFromList(forceAdvancedSignatureDetails, i)); + } + } + else { + map.put("force_advanced_signature_details", JSON.getDefault().getMapper().writeValueAsString(forceAdvancedSignatureDetails)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/node/api/templateApi.ts b/sdks/node/api/templateApi.ts index 49f7f54bd..f2ef5effe 100644 --- a/sdks/node/api/templateApi.ts +++ b/sdks/node/api/templateApi.ts @@ -1079,10 +1079,12 @@ export class TemplateApi { * Returns the Template specified by the `template_id` parameter. * @summary Get Template * @param templateId The id of the Template to retrieve. + * @param shallow _t__TemplateGet::SHALLOW * @param options */ public async templateGet( templateId: string, + shallow?: boolean, options: optionsI = { headers: {} } ): Promise> { const localVarPath = @@ -1113,6 +1115,13 @@ export class TemplateApi { ); } + if (shallow !== undefined) { + localVarQueryParameters["shallow"] = ObjectSerializer.serialize( + shallow, + "boolean" + ); + } + (Object).assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index d4d3b1261..da215c481 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -23254,6 +23254,10 @@ var SubSigningOptions = class _SubSigningOptions { * Allows uploading the signature */ this["upload"] = false; + /** + * Turning on advanced signature details for the signature request + */ + this["forceAdvancedSignatureDetails"] = false; } static { this.discriminator = void 0; @@ -23284,6 +23288,11 @@ var SubSigningOptions = class _SubSigningOptions { name: "upload", baseName: "upload", type: "boolean" + }, + { + name: "forceAdvancedSignatureDetails", + baseName: "force_advanced_signature_details", + type: "boolean" } ]; } @@ -35363,9 +35372,10 @@ var TemplateApi = class { * Returns the Template specified by the `template_id` parameter. * @summary Get Template * @param templateId The id of the Template to retrieve. + * @param shallow _t__TemplateGet::SHALLOW * @param options */ - async templateGet(templateId, options = { headers: {} }) { + async templateGet(templateId, shallow, options = { headers: {} }) { const localVarPath = this.basePath + "/template/{template_id}".replace( "{template_id}", encodeURIComponent(String(templateId)) @@ -35388,6 +35398,12 @@ var TemplateApi = class { "Required parameter templateId was null or undefined when calling templateGet." ); } + if (shallow !== void 0) { + localVarQueryParameters["shallow"] = ObjectSerializer.serialize( + shallow, + "boolean" + ); + } Object.assign(localVarHeaderParams, options.headers); let localVarUseFormData = false; let localVarRequestOptions = { diff --git a/sdks/node/docs/api/SignatureRequestApi.md b/sdks/node/docs/api/SignatureRequestApi.md index 58a4ac40c..20ddaf56f 100644 --- a/sdks/node/docs/api/SignatureRequestApi.md +++ b/sdks/node/docs/api/SignatureRequestApi.md @@ -366,6 +366,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signerExperience: models.SubSignerExperience = { @@ -468,6 +469,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signerExperience: models.SubSignerExperience = { @@ -1431,6 +1433,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signers1: models.SubSignatureRequestSigner = { @@ -1532,6 +1535,7 @@ const signingOptions: models.SubSigningOptions = { phone: false, type: true, upload: true, + force_advanced_signature_details: false, }; const signers1: models.SubSignatureRequestTemplateSigner = { diff --git a/sdks/node/docs/api/TemplateApi.md b/sdks/node/docs/api/TemplateApi.md index 486bb8253..7b194fb71 100644 --- a/sdks/node/docs/api/TemplateApi.md +++ b/sdks/node/docs/api/TemplateApi.md @@ -557,7 +557,7 @@ apiCaller.templateFilesAsFileUrl( ## `templateGet()` ```typescript -templateGet(templateId: string): TemplateGetResponse +templateGet(templateId: string, shallow: boolean): TemplateGetResponse ``` Get Template @@ -591,6 +591,7 @@ apiCaller.templateGet( |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **templateId** | **string**| The id of the Template to retrieve. | | +| **shallow** | **boolean**| _t__TemplateGet::SHALLOW | [optional] | ### Return type diff --git a/sdks/node/docs/model/SubSigningOptions.md b/sdks/node/docs/model/SubSigningOptions.md index 1e1c670f6..d795c194b 100644 --- a/sdks/node/docs/model/SubSigningOptions.md +++ b/sdks/node/docs/model/SubSigningOptions.md @@ -1,9 +1,11 @@ # # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. +This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. + ## Properties Name | Type | Description | Notes @@ -13,5 +15,6 @@ Name | Type | Description | Notes | `phone` | ```boolean``` | Allows using a smartphone to email the signature | [default to false] | | `type` | ```boolean``` | Allows typing the signature | [default to false] | | `upload` | ```boolean``` | Allows uploading the signature | [default to false] | +| `forceAdvancedSignatureDetails` | ```boolean``` | Turning on advanced signature details for the signature request | [default to false] | [[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/subSigningOptions.ts b/sdks/node/model/subSigningOptions.ts index 886d611c7..3e983dd78 100644 --- a/sdks/node/model/subSigningOptions.ts +++ b/sdks/node/model/subSigningOptions.ts @@ -25,7 +25,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; /** - * This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + * This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. */ export class SubSigningOptions { /** @@ -48,6 +48,10 @@ export class SubSigningOptions { * Allows uploading the signature */ "upload"?: boolean = false; + /** + * Turning on advanced signature details for the signature request + */ + "forceAdvancedSignatureDetails"?: boolean = false; static discriminator: string | undefined = undefined; @@ -77,6 +81,11 @@ export class SubSigningOptions { baseName: "upload", type: "boolean", }, + { + name: "forceAdvancedSignatureDetails", + baseName: "force_advanced_signature_details", + type: "boolean", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/types/api/templateApi.d.ts b/sdks/node/types/api/templateApi.d.ts index 98a126994..1ea8fdd16 100644 --- a/sdks/node/types/api/templateApi.d.ts +++ b/sdks/node/types/api/templateApi.d.ts @@ -31,7 +31,7 @@ export declare class TemplateApi { templateFiles(templateId: string, fileType?: "pdf" | "zip", options?: optionsI): Promise>; templateFilesAsDataUri(templateId: string, options?: optionsI): Promise>; templateFilesAsFileUrl(templateId: string, forceDownload?: number, options?: optionsI): Promise>; - templateGet(templateId: string, options?: optionsI): Promise>; + templateGet(templateId: string, shallow?: boolean, options?: optionsI): Promise>; templateList(accountId?: string, page?: number, pageSize?: number, query?: string, options?: optionsI): Promise>; templateRemoveUser(templateId: string, templateRemoveUserRequest: TemplateRemoveUserRequest, options?: optionsI): Promise>; templateUpdate(templateId: string, templateUpdateRequest: TemplateUpdateRequest, options?: optionsI): Promise>; diff --git a/sdks/node/types/model/subSigningOptions.d.ts b/sdks/node/types/model/subSigningOptions.d.ts index c81b643d3..865ccf317 100644 --- a/sdks/node/types/model/subSigningOptions.d.ts +++ b/sdks/node/types/model/subSigningOptions.d.ts @@ -5,6 +5,7 @@ export declare class SubSigningOptions { "phone"?: boolean; "type"?: boolean; "upload"?: boolean; + "forceAdvancedSignatureDetails"?: boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/README.md b/sdks/php/README.md index 956a4e21b..83fc10a4d 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -452,6 +452,6 @@ apisupport@hellosign.com This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: `3.0.0` - - Package version: `1.10-dev` + - Package version: `1.10.1764188144-dev` - Generator version: `7.12.0` - Build package: `org.openapitools.codegen.languages.PhpClientCodegen` diff --git a/sdks/php/VERSION b/sdks/php/VERSION index 1a9d86ec7..1ca73c50a 100644 --- a/sdks/php/VERSION +++ b/sdks/php/VERSION @@ -1 +1 @@ -1.10-dev +1.10.1764188144-dev diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index 626120a2b..a2828587d 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -368,7 +368,8 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); @@ -469,7 +470,8 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signer_experience = (new Dropbox\Sign\Model\SubSignerExperience()) ->setFormView(Dropbox\Sign\Model\SubSignerExperience::FORM_VIEW_DISABLED); @@ -1469,7 +1471,8 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") @@ -1572,7 +1575,8 @@ $signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) ->setDraw(true) ->setPhone(false) ->setType(true) - ->setUpload(true); + ->setUpload(true) + ->setForceAdvancedSignatureDetails(false); $signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) ->setRole("Client") diff --git a/sdks/php/docs/Api/TemplateApi.md b/sdks/php/docs/Api/TemplateApi.md index 7123d41d7..b625436be 100644 --- a/sdks/php/docs/Api/TemplateApi.md +++ b/sdks/php/docs/Api/TemplateApi.md @@ -573,7 +573,7 @@ try { ## `templateGet()` ```php -templateGet($template_id): \Dropbox\Sign\Model\TemplateGetResponse +templateGet($template_id, $shallow): \Dropbox\Sign\Model\TemplateGetResponse ``` Get Template @@ -612,6 +612,7 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **template_id** | **string**| The id of the Template to retrieve. | | +| **shallow** | **bool**| _t__TemplateGet::SHALLOW | [optional] | ### Return type diff --git a/sdks/php/docs/Model/SubSigningOptions.md b/sdks/php/docs/Model/SubSigningOptions.md index e2a1b1660..0a3d3a40e 100644 --- a/sdks/php/docs/Model/SubSigningOptions.md +++ b/sdks/php/docs/Model/SubSigningOptions.md @@ -1,9 +1,11 @@ # # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. +This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. + ## Properties Name | Type | Description | Notes @@ -13,5 +15,6 @@ Name | Type | Description | Notes | `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to false] | | `type` | ```bool``` | Allows typing the signature | [default to false] | | `upload` | ```bool``` | Allows uploading the signature | [default to false] | +| `force_advanced_signature_details` | ```bool``` | Turning on advanced signature details for the signature request | [default to false] | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/openapi-config.yaml b/sdks/php/openapi-config.yaml index da279249a..8bdd46715 100644 --- a/sdks/php/openapi-config.yaml +++ b/sdks/php/openapi-config.yaml @@ -2,7 +2,7 @@ generatorName: php additionalProperties: packageName: dropbox/sign packageVersion: "^1.10.0" - artifactVersion: 1.10-dev + artifactVersion: 1.10.1764188144-dev invokerPackage: "Dropbox\\Sign" sortModelPropertiesByRequiredFlag: true srcBasePath: src diff --git a/sdks/php/src/Api/TemplateApi.php b/sdks/php/src/Api/TemplateApi.php index 69a6937d1..9901b24b4 100644 --- a/sdks/php/src/Api/TemplateApi.php +++ b/sdks/php/src/Api/TemplateApi.php @@ -2466,15 +2466,16 @@ public function templateFilesAsFileUrlRequest(string $template_id, ?int $force_d * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) + * @param string $template_id The id of the Template to retrieve. (required) + * @param bool|null $shallow _t__TemplateGet::SHALLOW (optional) * * @return Model\TemplateGetResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format * @throws InvalidArgumentException */ - public function templateGet(string $template_id) + public function templateGet(string $template_id, ?bool $shallow = null) { - list($response) = $this->templateGetWithHttpInfo($template_id); + list($response) = $this->templateGetWithHttpInfo($template_id, $shallow); return $response; } @@ -2483,17 +2484,18 @@ public function templateGet(string $template_id) * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param bool|null $shallow _t__TemplateGet::SHALLOW (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * * @return array of Model\TemplateGetResponse, HTTP status code, HTTP response headers (array of strings) * @throws ApiException on non-2xx response or if the response body is not in the expected format * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetWithHttpInfo(string $template_id, ?bool $shallow = null, string $contentType = self::contentTypes['templateGet'][0]) { - $request = $this->templateGetRequest($template_id, $contentType); + $request = $this->templateGetRequest($template_id, $shallow, $contentType); try { $options = $this->createHttpClientOption(); @@ -2620,16 +2622,17 @@ public function templateGetWithHttpInfo(string $template_id, string $contentType * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param bool|null $shallow _t__TemplateGet::SHALLOW (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetAsync(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetAsync(string $template_id, ?bool $shallow = null, string $contentType = self::contentTypes['templateGet'][0]) { - return $this->templateGetAsyncWithHttpInfo($template_id, $contentType) + return $this->templateGetAsyncWithHttpInfo($template_id, $shallow, $contentType) ->then( function ($response) { return $response[0]; @@ -2642,17 +2645,18 @@ function ($response) { * * Get Template * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param bool|null $shallow _t__TemplateGet::SHALLOW (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetAsyncWithHttpInfo(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetAsyncWithHttpInfo(string $template_id, ?bool $shallow = null, string $contentType = self::contentTypes['templateGet'][0]) { $returnType = '\Dropbox\Sign\Model\TemplateGetResponse'; - $request = $this->templateGetRequest($template_id, $contentType); + $request = $this->templateGetRequest($template_id, $shallow, $contentType); return $this->client ->sendAsync($request, $this->createHttpClientOption()) @@ -2693,14 +2697,15 @@ function ($exception) { /** * Create request for operation 'templateGet' * - * @param string $template_id The id of the Template to retrieve. (required) - * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation + * @param string $template_id The id of the Template to retrieve. (required) + * @param bool|null $shallow _t__TemplateGet::SHALLOW (optional) + * @param string $contentType The value for the Content-Type header. Check self::contentTypes['templateGet'] to see the possible values for this operation * * @return Request * @throws InvalidArgumentException * @deprecated Prefer to use ::templateGet. This method will eventually become unavailable */ - public function templateGetRequest(string $template_id, string $contentType = self::contentTypes['templateGet'][0]) + public function templateGetRequest(string $template_id, ?bool $shallow = null, string $contentType = self::contentTypes['templateGet'][0]) { // verify the required parameter 'template_id' is set if ($template_id === null || (is_array($template_id) && count($template_id) === 0)) { @@ -2716,6 +2721,16 @@ public function templateGetRequest(string $template_id, string $contentType = se $httpBody = ''; $multipart = false; + // query params + $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue( + $shallow, + 'shallow', // param base name + 'boolean', // openApiType + 'form', // style + true, // explode + false // required + ) ?? []); + // path params if ($template_id !== null) { $resourcePath = str_replace( diff --git a/sdks/php/src/Configuration.php b/sdks/php/src/Configuration.php index cbd697cb4..36b35c8e9 100644 --- a/sdks/php/src/Configuration.php +++ b/sdks/php/src/Configuration.php @@ -97,7 +97,7 @@ class Configuration * * @var string */ - protected $userAgent = 'OpenAPI-Generator/1.10-dev/PHP'; + protected $userAgent = 'OpenAPI-Generator/1.10.1764188144-dev/PHP'; /** * Debug switch (default set to false) @@ -438,7 +438,7 @@ public static function toDebugReport() $report .= ' OS: ' . php_uname() . PHP_EOL; $report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL; $report .= ' The version of the OpenAPI document: 3.0.0' . PHP_EOL; - $report .= ' SDK Package Version: 1.10-dev' . PHP_EOL; + $report .= ' SDK Package Version: 1.10.1764188144-dev' . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; return $report; diff --git a/sdks/php/src/Model/SubSigningOptions.php b/sdks/php/src/Model/SubSigningOptions.php index 51185a7ac..445065b20 100644 --- a/sdks/php/src/Model/SubSigningOptions.php +++ b/sdks/php/src/Model/SubSigningOptions.php @@ -37,7 +37,7 @@ * SubSigningOptions Class Doc Comment * * @category Class - * @description This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + * @description This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. * @see https://openapi-generator.tech * @implements ArrayAccess */ @@ -63,6 +63,7 @@ class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable 'phone' => 'bool', 'type' => 'bool', 'upload' => 'bool', + 'force_advanced_signature_details' => 'bool', ]; /** @@ -78,6 +79,7 @@ class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable 'phone' => null, 'type' => null, 'upload' => null, + 'force_advanced_signature_details' => null, ]; /** @@ -91,6 +93,7 @@ class SubSigningOptions implements ModelInterface, ArrayAccess, JsonSerializable 'phone' => false, 'type' => false, 'upload' => false, + 'force_advanced_signature_details' => false, ]; /** @@ -176,6 +179,7 @@ public function isNullableSetToNull(string $property): bool 'phone' => 'phone', 'type' => 'type', 'upload' => 'upload', + 'force_advanced_signature_details' => 'force_advanced_signature_details', ]; /** @@ -189,6 +193,7 @@ public function isNullableSetToNull(string $property): bool 'phone' => 'setPhone', 'type' => 'setType', 'upload' => 'setUpload', + 'force_advanced_signature_details' => 'setForceAdvancedSignatureDetails', ]; /** @@ -202,6 +207,7 @@ public function isNullableSetToNull(string $property): bool 'phone' => 'getPhone', 'type' => 'getType', 'upload' => 'getUpload', + 'force_advanced_signature_details' => 'getForceAdvancedSignatureDetails', ]; /** @@ -285,6 +291,7 @@ public function __construct(?array $data = null) $this->setIfExists('phone', $data ?? [], false); $this->setIfExists('type', $data ?? [], false); $this->setIfExists('upload', $data ?? [], false); + $this->setIfExists('force_advanced_signature_details', $data ?? [], false); } /** @@ -503,6 +510,33 @@ public function setUpload(?bool $upload) return $this; } + /** + * Gets force_advanced_signature_details + * + * @return bool|null + */ + public function getForceAdvancedSignatureDetails() + { + return $this->container['force_advanced_signature_details']; + } + + /** + * Sets force_advanced_signature_details + * + * @param bool|null $force_advanced_signature_details Turning on advanced signature details for the signature request + * + * @return self + */ + public function setForceAdvancedSignatureDetails(?bool $force_advanced_signature_details) + { + if (is_null($force_advanced_signature_details)) { + throw new InvalidArgumentException('non-nullable force_advanced_signature_details cannot be null'); + } + $this->container['force_advanced_signature_details'] = $force_advanced_signature_details; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index f197c9f27..03bef4a20 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -425,6 +425,7 @@ with ApiClient(configuration) as api_client: phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signer_experience = models.SubSignerExperience( @@ -541,6 +542,7 @@ with ApiClient(configuration) as api_client: phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signer_experience = models.SubSignerExperience( @@ -1698,6 +1700,7 @@ with ApiClient(configuration) as api_client: phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signers_1 = models.SubSignatureRequestSigner( @@ -1815,6 +1818,7 @@ with ApiClient(configuration) as api_client: phone=False, type=True, upload=True, + force_advanced_signature_details=False, ) signers_1 = models.SubSignatureRequestTemplateSigner( diff --git a/sdks/python/docs/SubSigningOptions.md b/sdks/python/docs/SubSigningOptions.md index 9584478ec..23ddf9135 100644 --- a/sdks/python/docs/SubSigningOptions.md +++ b/sdks/python/docs/SubSigningOptions.md @@ -1,9 +1,11 @@ # SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. +This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -12,6 +14,7 @@ Name | Type | Description | Notes | `phone` | ```bool``` | Allows using a smartphone to email the signature | [default to False] | | `type` | ```bool``` | Allows typing the signature | [default to False] | | `upload` | ```bool``` | Allows uploading the signature | [default to False] | +| `force_advanced_signature_details` | ```bool``` | Turning on advanced signature details for the signature request | [default to False] | [[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 a6921af1a..0ba1a1e79 100644 --- a/sdks/python/docs/TemplateApi.md +++ b/sdks/python/docs/TemplateApi.md @@ -666,6 +666,7 @@ with ApiClient(configuration) as api_client: | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **str** | The id of the Template to retrieve. | | +| `shallow` | **bool** | _t__TemplateGet::SHALLOW | [optional] | ### Return type diff --git a/sdks/python/dropbox_sign/api/template_api.py b/sdks/python/dropbox_sign/api/template_api.py index ec5545853..2a935018c 100644 --- a/sdks/python/dropbox_sign/api/template_api.py +++ b/sdks/python/dropbox_sign/api/template_api.py @@ -17,7 +17,14 @@ from typing import Any, Dict, List, Optional, Tuple, Union from typing_extensions import Annotated -from pydantic import Field, StrictBytes, StrictInt, StrictStr, field_validator +from pydantic import ( + Field, + StrictBool, + StrictBytes, + StrictInt, + StrictStr, + field_validator, +) from typing import Optional, Tuple, Union from typing_extensions import Annotated from dropbox_sign.models.file_response import FileResponse @@ -1987,6 +1994,9 @@ def template_get( template_id: Annotated[ StrictStr, Field(description="The id of the Template to retrieve.") ], + shallow: Annotated[ + Optional[StrictBool], Field(description="_t__TemplateGet::SHALLOW") + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2005,6 +2015,8 @@ def template_get( :param template_id: The id of the Template to retrieve. (required) :type template_id: str + :param shallow: _t__TemplateGet::SHALLOW + :type shallow: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2029,6 +2041,7 @@ def template_get( _param = self._template_get_serialize( template_id=template_id, + shallow=shallow, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2054,6 +2067,9 @@ def template_get_with_http_info( template_id: Annotated[ StrictStr, Field(description="The id of the Template to retrieve.") ], + shallow: Annotated[ + Optional[StrictBool], Field(description="_t__TemplateGet::SHALLOW") + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2072,6 +2088,8 @@ def template_get_with_http_info( :param template_id: The id of the Template to retrieve. (required) :type template_id: str + :param shallow: _t__TemplateGet::SHALLOW + :type shallow: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2096,6 +2114,7 @@ def template_get_with_http_info( _param = self._template_get_serialize( template_id=template_id, + shallow=shallow, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2121,6 +2140,9 @@ def template_get_without_preload_content( template_id: Annotated[ StrictStr, Field(description="The id of the Template to retrieve.") ], + shallow: Annotated[ + Optional[StrictBool], Field(description="_t__TemplateGet::SHALLOW") + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2139,6 +2161,8 @@ def template_get_without_preload_content( :param template_id: The id of the Template to retrieve. (required) :type template_id: str + :param shallow: _t__TemplateGet::SHALLOW + :type shallow: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2163,6 +2187,7 @@ def template_get_without_preload_content( _param = self._template_get_serialize( template_id=template_id, + shallow=shallow, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2181,6 +2206,7 @@ def template_get_without_preload_content( def _template_get_serialize( self, template_id, + shallow, _request_auth, _content_type, _headers, @@ -2204,6 +2230,10 @@ def _template_get_serialize( if template_id is not None: _path_params["template_id"] = template_id # process the query parameters + if shallow is not None: + + _query_params.append(("shallow", shallow)) + # process the header parameters # process the form parameters # process the body parameter diff --git a/sdks/python/dropbox_sign/models/sub_signing_options.py b/sdks/python/dropbox_sign/models/sub_signing_options.py index 717d3a8d7..7d442bacf 100644 --- a/sdks/python/dropbox_sign/models/sub_signing_options.py +++ b/sdks/python/dropbox_sign/models/sub_signing_options.py @@ -36,7 +36,7 @@ class SubSigningOptions(BaseModel): """ - This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. """ # noqa: E501 default_type: StrictStr = Field( @@ -54,12 +54,17 @@ class SubSigningOptions(BaseModel): upload: Optional[StrictBool] = Field( default=False, description="Allows uploading the signature" ) + force_advanced_signature_details: Optional[StrictBool] = Field( + default=False, + description="Turning on advanced signature details for the signature request", + ) __properties: ClassVar[List[str]] = [ "default_type", "draw", "phone", "type", "upload", + "force_advanced_signature_details", ] @field_validator("default_type") @@ -139,6 +144,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "phone": obj.get("phone") if obj.get("phone") is not None else False, "type": obj.get("type") if obj.get("type") is not None else False, "upload": obj.get("upload") if obj.get("upload") is not None else False, + "force_advanced_signature_details": ( + obj.get("force_advanced_signature_details") + if obj.get("force_advanced_signature_details") is not None + else False + ), } ) return _obj @@ -161,6 +171,7 @@ def openapi_types(cls) -> Dict[str, str]: "phone": "(bool,)", "type": "(bool,)", "upload": "(bool,)", + "force_advanced_signature_details": "(bool,)", } @classmethod diff --git a/sdks/ruby/docs/SignatureRequestApi.md b/sdks/ruby/docs/SignatureRequestApi.md index 782ede630..a351a2e6e 100644 --- a/sdks/ruby/docs/SignatureRequestApi.md +++ b/sdks/ruby/docs/SignatureRequestApi.md @@ -390,6 +390,7 @@ signing_options.draw = true signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signer_experience = Dropbox::Sign::SubSignerExperience.new signer_experience.form_view = "disabled" @@ -501,6 +502,7 @@ signing_options.draw = true signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signer_experience = Dropbox::Sign::SubSignerExperience.new signer_experience.form_view = "disabled" @@ -1629,6 +1631,7 @@ signing_options.draw = true signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new signers_1.name = "Jack" @@ -1743,6 +1746,7 @@ signing_options.draw = true signing_options.phone = false signing_options.type = true signing_options.upload = true +signing_options.force_advanced_signature_details = false signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new signers_1.role = "Client" diff --git a/sdks/ruby/docs/SubSigningOptions.md b/sdks/ruby/docs/SubSigningOptions.md index d2eb449f7..026659a88 100644 --- a/sdks/ruby/docs/SubSigningOptions.md +++ b/sdks/ruby/docs/SubSigningOptions.md @@ -1,9 +1,11 @@ # Dropbox::Sign::SubSigningOptions -This allows the requester to specify the types allowed for creating a signature. +This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. +**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. + ## Properties | Name | Type | Description | Notes | @@ -13,4 +15,5 @@ This allows the requester to specify the types allowed for creating a signature. | `phone` | ```Boolean``` | Allows using a smartphone to email the signature | [default to false] | | `type` | ```Boolean``` | Allows typing the signature | [default to false] | | `upload` | ```Boolean``` | Allows uploading the signature | [default to false] | +| `force_advanced_signature_details` | ```Boolean``` | Turning on advanced signature details for the signature request | [default to false] | diff --git a/sdks/ruby/docs/TemplateApi.md b/sdks/ruby/docs/TemplateApi.md index bfe23251f..999cd8bcf 100644 --- a/sdks/ruby/docs/TemplateApi.md +++ b/sdks/ruby/docs/TemplateApi.md @@ -639,7 +639,7 @@ end ## `template_get` -> ` template_get(template_id)` +> ` template_get(template_id, opts)` Get Template @@ -672,12 +672,12 @@ end This returns an Array which contains the response data, status code and headers. -> `, Integer, Hash)> template_get_with_http_info(template_id)` +> `, Integer, Hash)> template_get_with_http_info(template_id, opts)` ```ruby begin # Get Template - data, status_code, headers = api_instance.template_get_with_http_info(template_id) + data, status_code, headers = api_instance.template_get_with_http_info(template_id, opts) p status_code # => 2xx p headers # => { ... } p data # => @@ -691,6 +691,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `template_id` | **String** | The id of the Template to retrieve. | | +| `shallow` | **Boolean** | _t__TemplateGet::SHALLOW | [optional] | ### Return type diff --git a/sdks/ruby/lib/dropbox-sign/api/template_api.rb b/sdks/ruby/lib/dropbox-sign/api/template_api.rb index 39d4a6228..9823f1b17 100644 --- a/sdks/ruby/lib/dropbox-sign/api/template_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/template_api.rb @@ -718,6 +718,7 @@ def template_files_as_file_url_with_http_info(template_id, opts = {}) # Returns the Template specified by the `template_id` parameter. # @param template_id [String] The id of the Template to retrieve. # @param [Hash] opts the optional parameters + # @option opts [Boolean] :shallow _t__TemplateGet::SHALLOW # @return [TemplateGetResponse] def template_get(template_id, opts = {}) data, _status_code, _headers = template_get_with_http_info(template_id, opts) @@ -728,6 +729,7 @@ def template_get(template_id, opts = {}) # Returns the Template specified by the `template_id` parameter. # @param template_id [String] The id of the Template to retrieve. # @param [Hash] opts the optional parameters + # @option opts [Boolean] :shallow _t__TemplateGet::SHALLOW # @return [Array<(TemplateGetResponse, Integer, Hash)>] TemplateGetResponse data, response status code and response headers def template_get_with_http_info(template_id, opts = {}) if @api_client.config.debugging @@ -742,6 +744,7 @@ def template_get_with_http_info(template_id, opts = {}) # query parameters query_params = opts[:query_params] || {} + query_params[:'shallow'] = opts[:'shallow'] if !opts[:'shallow'].nil? # header parameters header_params = opts[:header_params] || {} diff --git a/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb b/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb index 26a6406f7..7d0969ded 100644 --- a/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb +++ b/sdks/ruby/lib/dropbox-sign/models/sub_signing_options.rb @@ -17,7 +17,7 @@ module Dropbox end module Dropbox::Sign - # This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + # This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. class SubSigningOptions # The default type shown (limited to the listed types) # @return [String] @@ -39,6 +39,10 @@ class SubSigningOptions # @return [Boolean] attr_accessor :upload + # Turning on advanced signature details for the signature request + # @return [Boolean] + attr_accessor :force_advanced_signature_details + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -68,7 +72,8 @@ def self.attribute_map :'draw' => :'draw', :'phone' => :'phone', :'type' => :'type', - :'upload' => :'upload' + :'upload' => :'upload', + :'force_advanced_signature_details' => :'force_advanced_signature_details' } end @@ -89,7 +94,8 @@ def self.openapi_types :'draw' => :'Boolean', :'phone' => :'Boolean', :'type' => :'Boolean', - :'upload' => :'Boolean' + :'upload' => :'Boolean', + :'force_advanced_signature_details' => :'Boolean' } end @@ -167,6 +173,12 @@ def initialize(attributes = {}) else self.upload = false end + + if attributes.key?(:'force_advanced_signature_details') + self.force_advanced_signature_details = attributes[:'force_advanced_signature_details'] + else + self.force_advanced_signature_details = false + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -208,7 +220,8 @@ def ==(o) draw == o.draw && phone == o.phone && type == o.type && - upload == o.upload + upload == o.upload && + force_advanced_signature_details == o.force_advanced_signature_details end # @see the `==` method @@ -220,7 +233,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [default_type, draw, phone, type, upload].hash + [default_type, draw, phone, type, upload, force_advanced_signature_details].hash end # Builds the object from hash diff --git a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json index 1f506686a..37bc79c81 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json @@ -119,7 +119,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "subject": "The NDA we talked about", "test_mode": true, @@ -258,7 +259,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "subject": "The NDA we talked about", "test_mode": true, diff --git a/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json index a9597ea64..f997b281e 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json @@ -54,7 +54,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "subject": "Purchase Order", "template_ids": [ diff --git a/test_fixtures/SignatureRequestSendRequest.json b/test_fixtures/SignatureRequestSendRequest.json index cfc2f4f33..f0d7b9df0 100644 --- a/test_fixtures/SignatureRequestSendRequest.json +++ b/test_fixtures/SignatureRequestSendRequest.json @@ -232,7 +232,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "signing_redirect_url": "https://example.com/redirect", "subject": "The NDA we talked about", @@ -474,7 +475,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "signing_redirect_url": "https://example.com/redirect", "subject": "The NDA we talked about", diff --git a/test_fixtures/SignatureRequestSendWithTemplateRequest.json b/test_fixtures/SignatureRequestSendWithTemplateRequest.json index 4d1cc8665..df8e207c7 100644 --- a/test_fixtures/SignatureRequestSendWithTemplateRequest.json +++ b/test_fixtures/SignatureRequestSendWithTemplateRequest.json @@ -42,7 +42,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "signing_redirect_url": "https://example.com/redirect", "subject": "Purchase Order", diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json index e18890b74..addbe6ac5 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json @@ -127,7 +127,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "signing_redirect_url": "https://example.com/redirect", "show_progress_stepper": true, diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json index 7c7264948..d4f26cd76 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json @@ -58,7 +58,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "show_progress_stepper": true, "skip_me_now": true, diff --git a/test_fixtures/UnclaimedDraftCreateRequest.json b/test_fixtures/UnclaimedDraftCreateRequest.json index 56aa4a024..cc17e68ac 100644 --- a/test_fixtures/UnclaimedDraftCreateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateRequest.json @@ -117,7 +117,8 @@ "type": true, "upload": true, "phone": false, - "default_type": "draw" + "default_type": "draw", + "force_advanced_signature_details": false }, "signing_redirect_url": "https://example.com/redirect", "subject": "The NDA we talked about", diff --git a/translations/en.yaml b/translations/en.yaml index 35368c9c7..1b6171070 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1231,14 +1231,17 @@ "Sub::SignerRole::ORDER": The order in which this signer role is required to sign. "Sub::SigningOptions::DESCRIPTION": |- - This allows the requester to specify the types allowed for creating a signature. + This allows the requester to specify the types allowed for creating a signature and specify another signing options. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. + + **NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too. "Sub::SigningOptions::DEFAULT": The default type shown (limited to the listed types) "Sub::SigningOptions::DRAW": Allows drawing the signature "Sub::SigningOptions::PHONE": Allows using a smartphone to email the signature "Sub::SigningOptions::TYPE": Allows typing the signature "Sub::SigningOptions::UPLOAD": Allows uploading the signature +"Sub::SigningOptions::FORCE_ADVANCED_SIGNATURE_DETAILS": Turning on advanced signature details for the signature request "Sub::UpdateFormField::API_ID": The unique ID for this field. The endpoint will update an existing field with matching `api_id`, and warn you if no matches are found "Sub::UpdateFormField::NAME": The new name of the field. If not passed the name will remain unchanged.