From 0e92f7a8bb771e9265e80a8ebf9d2a0906430144 Mon Sep 17 00:00:00 2001 From: mchatlas-hellosign Date: Mon, 10 Aug 2026 12:44:31 +0200 Subject: [PATCH 1/6] Allowed ignoring text tag errors (#551) --- openapi-raw.yaml | 39 ++++++++++ openapi-sdk.yaml | 32 +++++++++ openapi.yaml | 4 ++ .../SignatureRequestCreateEmbeddedRequest.md | 2 +- .../SignatureRequestEditEmbeddedRequest.md | 2 +- .../docs/SignatureRequestEditRequest.md | 2 +- .../docs/SignatureRequestSendRequest.md | 2 +- .../TemplateCreateEmbeddedDraftRequest.md | 2 +- sdks/dotnet/docs/TemplateCreateRequest.md | 2 +- .../UnclaimedDraftCreateEmbeddedRequest.md | 2 +- .../docs/UnclaimedDraftCreateRequest.md | 2 +- .../SignatureRequestCreateEmbeddedRequest.cs | 24 ++++++- .../SignatureRequestEditEmbeddedRequest.cs | 24 ++++++- .../Model/SignatureRequestEditRequest.cs | 24 ++++++- .../Model/SignatureRequestSendRequest.cs | 24 ++++++- .../TemplateCreateEmbeddedDraftRequest.cs | 24 ++++++- .../Model/TemplateCreateRequest.cs | 24 ++++++- .../UnclaimedDraftCreateEmbeddedRequest.cs | 24 ++++++- .../Model/UnclaimedDraftCreateRequest.cs | 24 ++++++- .../SignatureRequestCreateEmbeddedRequest.md | 1 + .../SignatureRequestEditEmbeddedRequest.md | 1 + .../docs/SignatureRequestEditRequest.md | 1 + .../docs/SignatureRequestSendRequest.md | 1 + .../TemplateCreateEmbeddedDraftRequest.md | 1 + sdks/java-v1/docs/TemplateCreateRequest.md | 1 + .../UnclaimedDraftCreateEmbeddedRequest.md | 1 + .../docs/UnclaimedDraftCreateRequest.md | 1 + ...SignatureRequestCreateEmbeddedRequest.java | 61 ++++++++++++++++ .../SignatureRequestEditEmbeddedRequest.java | 61 ++++++++++++++++ .../model/SignatureRequestEditRequest.java | 61 ++++++++++++++++ .../model/SignatureRequestSendRequest.java | 61 ++++++++++++++++ .../TemplateCreateEmbeddedDraftRequest.java | 67 ++++++++++++++++- .../sign/model/TemplateCreateRequest.java | 67 ++++++++++++++++- .../UnclaimedDraftCreateEmbeddedRequest.java | 61 ++++++++++++++++ .../model/UnclaimedDraftCreateRequest.java | 61 ++++++++++++++++ .../SignatureRequestCreateEmbeddedRequest.md | 1 + .../SignatureRequestEditEmbeddedRequest.md | 1 + .../docs/SignatureRequestEditRequest.md | 1 + .../docs/SignatureRequestSendRequest.md | 1 + .../TemplateCreateEmbeddedDraftRequest.md | 1 + sdks/java-v2/docs/TemplateCreateRequest.md | 1 + .../UnclaimedDraftCreateEmbeddedRequest.md | 1 + .../docs/UnclaimedDraftCreateRequest.md | 1 + ...SignatureRequestCreateEmbeddedRequest.java | 53 +++++++++++++- .../SignatureRequestEditEmbeddedRequest.java | 53 +++++++++++++- .../model/SignatureRequestEditRequest.java | 53 +++++++++++++- .../model/SignatureRequestSendRequest.java | 53 +++++++++++++- .../TemplateCreateEmbeddedDraftRequest.java | 57 ++++++++++++++- .../sign/model/TemplateCreateRequest.java | 57 ++++++++++++++- .../UnclaimedDraftCreateEmbeddedRequest.java | 53 +++++++++++++- .../model/UnclaimedDraftCreateRequest.java | 53 +++++++++++++- sdks/node/dist/api.js | 72 +++++++++++++++++++ .../SignatureRequestCreateEmbeddedRequest.md | 1 + .../SignatureRequestEditEmbeddedRequest.md | 1 + .../docs/model/SignatureRequestEditRequest.md | 1 + .../docs/model/SignatureRequestSendRequest.md | 1 + .../TemplateCreateEmbeddedDraftRequest.md | 1 + sdks/node/docs/model/TemplateCreateRequest.md | 1 + .../UnclaimedDraftCreateEmbeddedRequest.md | 1 + .../docs/model/UnclaimedDraftCreateRequest.md | 1 + .../signatureRequestCreateEmbeddedRequest.ts | 9 +++ .../signatureRequestEditEmbeddedRequest.ts | 9 +++ .../node/model/signatureRequestEditRequest.ts | 9 +++ .../node/model/signatureRequestSendRequest.ts | 9 +++ .../templateCreateEmbeddedDraftRequest.ts | 9 +++ sdks/node/model/templateCreateRequest.ts | 9 +++ .../unclaimedDraftCreateEmbeddedRequest.ts | 9 +++ .../node/model/unclaimedDraftCreateRequest.ts | 9 +++ ...signatureRequestCreateEmbeddedRequest.d.ts | 1 + .../signatureRequestEditEmbeddedRequest.d.ts | 1 + .../model/signatureRequestEditRequest.d.ts | 1 + .../model/signatureRequestSendRequest.d.ts | 1 + .../templateCreateEmbeddedDraftRequest.d.ts | 1 + .../types/model/templateCreateRequest.d.ts | 1 + .../unclaimedDraftCreateEmbeddedRequest.d.ts | 1 + .../model/unclaimedDraftCreateRequest.d.ts | 1 + .../SignatureRequestCreateEmbeddedRequest.md | 1 + .../SignatureRequestEditEmbeddedRequest.md | 1 + .../docs/Model/SignatureRequestEditRequest.md | 1 + .../docs/Model/SignatureRequestSendRequest.md | 1 + .../TemplateCreateEmbeddedDraftRequest.md | 1 + sdks/php/docs/Model/TemplateCreateRequest.md | 1 + .../UnclaimedDraftCreateEmbeddedRequest.md | 1 + .../docs/Model/UnclaimedDraftCreateRequest.md | 1 + .../SignatureRequestCreateEmbeddedRequest.php | 34 +++++++++ .../SignatureRequestEditEmbeddedRequest.php | 34 +++++++++ .../src/Model/SignatureRequestEditRequest.php | 34 +++++++++ .../src/Model/SignatureRequestSendRequest.php | 34 +++++++++ .../TemplateCreateEmbeddedDraftRequest.php | 34 +++++++++ sdks/php/src/Model/TemplateCreateRequest.php | 34 +++++++++ .../UnclaimedDraftCreateEmbeddedRequest.php | 34 +++++++++ .../src/Model/UnclaimedDraftCreateRequest.php | 34 +++++++++ sdks/python/docs/SignatureRequestApi.md | 12 ++-- .../SignatureRequestCreateEmbeddedRequest.md | 1 + .../SignatureRequestEditEmbeddedRequest.md | 1 + .../docs/SignatureRequestEditRequest.md | 1 + .../docs/SignatureRequestSendRequest.md | 1 + .../TemplateCreateEmbeddedDraftRequest.md | 1 + sdks/python/docs/TemplateCreateRequest.md | 1 + .../UnclaimedDraftCreateEmbeddedRequest.md | 1 + .../docs/UnclaimedDraftCreateRequest.md | 1 + sdks/python/dropbox_sign/api_client.py | 1 + sdks/python/dropbox_sign/configuration.py | 2 + sdks/python/dropbox_sign/models/__init__.py | 1 + .../models/account_create_request.py | 1 + .../models/account_create_response.py | 1 + .../models/account_get_response.py | 1 + .../dropbox_sign/models/account_response.py | 1 + .../models/account_response_quotas.py | 1 + .../models/account_response_settings.py | 1 + .../models/account_response_usage.py | 1 + .../models/account_update_request.py | 1 + .../models/account_verify_request.py | 1 + .../models/account_verify_response.py | 1 + .../models/account_verify_response_account.py | 1 + .../models/api_app_create_request.py | 1 + .../models/api_app_get_response.py | 1 + .../models/api_app_list_response.py | 1 + .../dropbox_sign/models/api_app_response.py | 1 + .../models/api_app_response_o_auth.py | 1 + .../models/api_app_response_options.py | 1 + .../models/api_app_response_owner_account.py | 1 + ...api_app_response_white_labeling_options.py | 1 + .../models/api_app_update_request.py | 1 + .../models/bulk_send_job_get_response.py | 1 + ...end_job_get_response_signature_requests.py | 1 + .../models/bulk_send_job_list_response.py | 1 + .../models/bulk_send_job_response.py | 1 + .../models/bulk_send_job_send_response.py | 1 + .../models/embedded_edit_url_request.py | 1 + .../models/embedded_edit_url_response.py | 1 + .../embedded_edit_url_response_embedded.py | 1 + .../models/embedded_sign_url_response.py | 1 + .../embedded_sign_url_response_embedded.py | 1 + .../dropbox_sign/models/error_response.py | 1 + .../models/error_response_error.py | 1 + .../models/event_callback_request.py | 1 + .../models/event_callback_request_event.py | 1 + .../event_callback_request_event_metadata.py | 1 + .../dropbox_sign/models/fax_get_response.py | 1 + .../models/fax_line_add_user_request.py | 1 + .../fax_line_area_code_get_country_enum.py | 1 + .../fax_line_area_code_get_province_enum.py | 1 + .../models/fax_line_area_code_get_response.py | 1 + .../fax_line_area_code_get_state_enum.py | 1 + .../models/fax_line_create_request.py | 1 + .../models/fax_line_delete_request.py | 1 + .../models/fax_line_list_response.py | 1 + .../models/fax_line_remove_user_request.py | 1 + .../dropbox_sign/models/fax_line_response.py | 1 + .../models/fax_line_response_fax_line.py | 1 + .../dropbox_sign/models/fax_list_response.py | 1 + .../dropbox_sign/models/fax_response.py | 1 + .../models/fax_response_transmission.py | 1 + .../dropbox_sign/models/fax_send_request.py | 1 + .../dropbox_sign/models/file_response.py | 1 + .../models/file_response_data_uri.py | 1 + .../dropbox_sign/models/list_info_response.py | 1 + .../models/o_auth_token_generate_request.py | 1 + .../models/o_auth_token_refresh_request.py | 1 + .../models/o_auth_token_response.py | 1 + .../models/report_create_request.py | 1 + .../models/report_create_response.py | 1 + .../dropbox_sign/models/report_response.py | 1 + ...k_create_embedded_with_template_request.py | 1 + ...request_bulk_send_with_template_request.py | 1 + ...gnature_request_create_embedded_request.py | 12 ++++ ...t_create_embedded_with_template_request.py | 1 + ...signature_request_edit_embedded_request.py | 12 ++++ ...est_edit_embedded_with_template_request.py | 1 + .../models/signature_request_edit_request.py | 12 ++++ ...ture_request_edit_with_template_request.py | 1 + .../models/signature_request_get_response.py | 1 + .../models/signature_request_list_response.py | 1 + .../signature_request_remind_request.py | 1 + .../models/signature_request_response.py | 1 + .../signature_request_response_attachment.py | 1 + ...ture_request_response_custom_field_base.py | 1 + ..._request_response_custom_field_checkbox.py | 1 + ...ture_request_response_custom_field_text.py | 1 + ...request_response_custom_field_type_enum.py | 1 + .../signature_request_response_data_base.py | 1 + ...gnature_request_response_data_type_enum.py | 1 + ...re_request_response_data_value_checkbox.py | 1 + ...uest_response_data_value_checkbox_merge.py | 1 + ...request_response_data_value_date_signed.py | 1 + ...re_request_response_data_value_dropdown.py | 1 + ...re_request_response_data_value_initials.py | 1 + ...ature_request_response_data_value_radio.py | 1 + ...e_request_response_data_value_signature.py | 1 + ...nature_request_response_data_value_text.py | 1 + ..._request_response_data_value_text_merge.py | 1 + .../signature_request_response_signatures.py | 1 + .../models/signature_request_send_request.py | 12 ++++ ...ture_request_send_with_template_request.py | 1 + .../signature_request_update_request.py | 1 + .../dropbox_sign/models/sub_attachment.py | 1 + .../models/sub_bulk_signer_list.py | 1 + .../sub_bulk_signer_list_custom_field.py | 1 + sdks/python/dropbox_sign/models/sub_cc.py | 1 + .../dropbox_sign/models/sub_custom_field.py | 1 + .../dropbox_sign/models/sub_editor_options.py | 1 + .../dropbox_sign/models/sub_field_options.py | 1 + .../models/sub_form_field_group.py | 1 + .../models/sub_form_field_rule.py | 1 + .../models/sub_form_field_rule_action.py | 1 + .../models/sub_form_field_rule_trigger.py | 1 + .../sub_form_fields_per_document_base.py | 1 + .../sub_form_fields_per_document_checkbox.py | 1 + ...form_fields_per_document_checkbox_merge.py | 1 + ...ub_form_fields_per_document_date_signed.py | 1 + .../sub_form_fields_per_document_dropdown.py | 1 + .../sub_form_fields_per_document_font_enum.py | 1 + .../sub_form_fields_per_document_hyperlink.py | 1 + .../sub_form_fields_per_document_initials.py | 1 + .../sub_form_fields_per_document_radio.py | 1 + .../sub_form_fields_per_document_signature.py | 1 + .../sub_form_fields_per_document_text.py | 1 + ...sub_form_fields_per_document_text_merge.py | 1 + .../sub_form_fields_per_document_type_enum.py | 1 + .../dropbox_sign/models/sub_merge_field.py | 1 + sdks/python/dropbox_sign/models/sub_o_auth.py | 1 + .../python/dropbox_sign/models/sub_options.py | 1 + .../sub_signature_request_grouped_signers.py | 1 + .../models/sub_signature_request_signer.py | 1 + .../sub_signature_request_template_signer.py | 1 + .../models/sub_signing_options.py | 1 + .../dropbox_sign/models/sub_team_response.py | 1 + .../dropbox_sign/models/sub_template_role.py | 1 + .../models/sub_unclaimed_draft_signer.py | 1 + .../sub_unclaimed_draft_template_signer.py | 1 + .../models/sub_white_labeling_options.py | 1 + .../models/team_add_member_request.py | 1 + .../models/team_create_request.py | 1 + .../models/team_get_info_response.py | 1 + .../dropbox_sign/models/team_get_response.py | 1 + .../dropbox_sign/models/team_info_response.py | 1 + .../models/team_invite_response.py | 1 + .../models/team_invites_response.py | 1 + .../models/team_member_response.py | 1 + .../models/team_members_response.py | 1 + .../models/team_parent_response.py | 1 + .../models/team_remove_member_request.py | 1 + .../dropbox_sign/models/team_response.py | 1 + .../models/team_sub_teams_response.py | 1 + .../models/team_update_request.py | 1 + .../models/template_add_user_request.py | 1 + .../template_create_embedded_draft_request.py | 12 ++++ ...template_create_embedded_draft_response.py | 1 + ...create_embedded_draft_response_template.py | 1 + .../models/template_create_request.py | 12 ++++ .../models/template_create_response.py | 1 + .../template_create_response_template.py | 1 + .../models/template_get_response.py | 1 + .../models/template_list_response.py | 1 + .../models/template_remove_user_request.py | 1 + .../dropbox_sign/models/template_response.py | 1 + .../models/template_response_account.py | 1 + .../models/template_response_account_quota.py | 1 + .../models/template_response_cc_role.py | 1 + .../models/template_response_document.py | 1 + ...ate_response_document_custom_field_base.py | 1 + ...response_document_custom_field_checkbox.py | 1 + ...ate_response_document_custom_field_text.py | 1 + .../template_response_document_field_group.py | 1 + ...late_response_document_field_group_rule.py | 1 + ...plate_response_document_form_field_base.py | 1 + ...e_response_document_form_field_checkbox.py | 1 + ...esponse_document_form_field_date_signed.py | 1 + ...e_response_document_form_field_dropdown.py | 1 + ..._response_document_form_field_hyperlink.py | 1 + ...e_response_document_form_field_initials.py | 1 + ...late_response_document_form_field_radio.py | 1 + ..._response_document_form_field_signature.py | 1 + ...plate_response_document_form_field_text.py | 1 + ...ate_response_document_static_field_base.py | 1 + ...response_document_static_field_checkbox.py | 1 + ...ponse_document_static_field_date_signed.py | 1 + ...response_document_static_field_dropdown.py | 1 + ...esponse_document_static_field_hyperlink.py | 1 + ...response_document_static_field_initials.py | 1 + ...te_response_document_static_field_radio.py | 1 + ...esponse_document_static_field_signature.py | 1 + ...ate_response_document_static_field_text.py | 1 + ...template_response_field_avg_text_length.py | 1 + .../models/template_response_signer_role.py | 1 + .../models/template_update_files_request.py | 1 + .../models/template_update_files_response.py | 1 + ...template_update_files_response_template.py | 1 + ...unclaimed_draft_create_embedded_request.py | 12 ++++ ...t_create_embedded_with_template_request.py | 1 + .../models/unclaimed_draft_create_request.py | 12 ++++ .../models/unclaimed_draft_create_response.py | 1 + ...unclaimed_draft_edit_and_resend_request.py | 1 + .../models/unclaimed_draft_response.py | 1 + .../dropbox_sign/models/warning_response.py | 1 + sdks/python/dropbox_sign/rest.py | 1 + .../templates/test-requirements.mustache | 2 +- sdks/python/test-requirements.txt | 2 +- .../SignatureRequestCreateEmbeddedRequest.md | 1 + .../SignatureRequestEditEmbeddedRequest.md | 1 + sdks/ruby/docs/SignatureRequestEditRequest.md | 1 + sdks/ruby/docs/SignatureRequestSendRequest.md | 1 + .../TemplateCreateEmbeddedDraftRequest.md | 1 + sdks/ruby/docs/TemplateCreateRequest.md | 1 + .../UnclaimedDraftCreateEmbeddedRequest.md | 1 + sdks/ruby/docs/UnclaimedDraftCreateRequest.md | 1 + ...gnature_request_create_embedded_request.rb | 15 +++- ...signature_request_edit_embedded_request.rb | 15 +++- .../models/signature_request_edit_request.rb | 15 +++- .../models/signature_request_send_request.rb | 15 +++- .../template_create_embedded_draft_request.rb | 21 ++++-- .../models/template_create_request.rb | 21 ++++-- ...unclaimed_draft_create_embedded_request.rb | 15 +++- .../models/unclaimed_draft_create_request.rb | 15 +++- ...SignatureRequestCreateEmbeddedRequest.json | 6 +- .../SignatureRequestSendRequest.json | 6 +- .../TemplateCreateEmbeddedDraftRequest.json | 3 +- .../UnclaimedDraftCreateEmbeddedRequest.json | 3 +- .../UnclaimedDraftCreateRequest.json | 3 +- translations/en.yaml | 6 ++ 321 files changed, 2086 insertions(+), 61 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 132929285..8dcb5683e 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -8462,6 +8462,10 @@ components: description: '_t__SignatureRequestCreateEmbedded::USE_TEXT_TAGS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__SignatureRequestCreateEmbedded::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false populate_auto_fill_fields: description: '_t__SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS' type: boolean @@ -8664,6 +8668,11 @@ components: description: '_t__SignatureRequestSend::USE_PREEXISTING_FIELDS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__SignatureRequestSend::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false + x-hideOn: doc expires_at: description: '_t__SignatureRequestSend::EXPIRES_AT' type: integer @@ -8777,6 +8786,11 @@ components: description: '_t__SignatureRequestCreateEmbedded::USE_TEXT_TAGS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__SignatureRequestCreateEmbedded::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false + x-hideOn: doc populate_auto_fill_fields: description: '_t__SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS' type: boolean @@ -9080,6 +9094,11 @@ components: description: '_t__SignatureRequestSend::USE_PREEXISTING_FIELDS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__SignatureRequestSend::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false + x-hideOn: doc expires_at: description: '_t__SignatureRequestSend::EXPIRES_AT' type: integer @@ -10267,6 +10286,11 @@ components: description: '_t__TemplateCreate::USE_PREEXISTING_FIELDS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__TemplateCreate::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false + x-hideOn: doc signer_experience: description: '_t__TemplateCreate::SIGNER_EXPERIENCE' allOf: @@ -10385,6 +10409,11 @@ components: description: '_t__TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__TemplateCreateEmbeddedDraft::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false + x-hideOn: doc signer_experience: description: '_t__TemplateCreateEmbeddedDraft::SIGNER_EXPERIENCE' allOf: @@ -10573,6 +10602,11 @@ components: description: '_t__UnclaimedDraftCreate::USE_TEXT_TAGS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__UnclaimedDraftCreate::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false + x-hideOn: doc expires_at: description: '_t__UnclaimedDraftCreate::EXPIRES_AT' type: integer @@ -10733,6 +10767,11 @@ components: description: '_t__UnclaimedDraftCreateEmbedded::USE_TEXT_TAGS' type: boolean default: false + ignore_text_tags_extraction_errors: + description: '_t__UnclaimedDraftCreateEmbedded::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS' + type: boolean + default: false + x-hideOn: doc populate_auto_fill_fields: description: '_t__UnclaimedDraftCreateEmbedded::POPULATE_AUTO_FILL_FIELDS' type: boolean diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index ed174d3ca..ac9e78860 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -8553,6 +8553,10 @@ components: description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false populate_auto_fill_fields: description: |- Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. @@ -8798,6 +8802,10 @@ components: description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false expires_at: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer @@ -8943,6 +8951,10 @@ components: description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false populate_auto_fill_fields: description: |- Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. @@ -9298,6 +9310,10 @@ components: description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false expires_at: description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer @@ -10655,6 +10671,10 @@ components: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false type: object TemplateCreateEmbeddedDraftRequest: required: @@ -10797,6 +10817,10 @@ components: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false type: object TemplateRemoveUserRequest: properties: @@ -10976,6 +11000,10 @@ components: description: 'Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false expires_at: description: |- When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. @@ -11166,6 +11194,10 @@ components: description: 'Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false populate_auto_fill_fields: description: |- Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. diff --git a/openapi.yaml b/openapi.yaml index 41e64091d..11147f6e2 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -8553,6 +8553,10 @@ components: description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' type: boolean default: false + ignore_text_tags_extraction_errors: + description: 'Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.' + type: boolean + default: false populate_auto_fill_fields: description: |- Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. diff --git a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md index babeb4eb2..b2ccd4120 100644 --- a/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/dotnet/docs/SignatureRequestCreateEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md index 3d7e41773..60994a1b7 100644 --- a/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestEditRequest.md b/sdks/dotnet/docs/SignatureRequestEditRequest.md index bb50808de..2658b8ee6 100644 --- a/sdks/dotnet/docs/SignatureRequestEditRequest.md +++ b/sdks/dotnet/docs/SignatureRequestEditRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**IgnoreTextTagsExtractionErrors** | **bool** | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/SignatureRequestSendRequest.md b/sdks/dotnet/docs/SignatureRequestSendRequest.md index 5261aeb91..f5af34b54 100644 --- a/sdks/dotnet/docs/SignatureRequestSendRequest.md +++ b/sdks/dotnet/docs/SignatureRequestSendRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional] **SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional] **Subject** | **string** | The subject in the email that will be sent to the signers. | [optional] **TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UseTextTags** | **bool** | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [optional] [default to false]**IgnoreTextTagsExtractionErrors** | **bool** | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [optional] [default to false]**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | [optional] [[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/TemplateCreateEmbeddedDraftRequest.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md index 299d6feef..5e664f481 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional] **Subject** | **string** | The template title (alias). | [optional] **TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional] **UsePreexistingFields** | **bool** | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [optional] [default to false]**IgnoreTextTagsExtractionErrors** | **bool** | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md index d3bc89c77..907837963 100644 --- a/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/dotnet/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ClientId** | **string** | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | **RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs index 310802209..164799418 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestCreateEmbeddedRequest.cs @@ -63,9 +63,10 @@ protected SignatureRequestCreateEmbeddedRequest() { } /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public SignatureRequestCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool ignoreTextTagsExtractionErrors = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -95,6 +96,7 @@ protected SignatureRequestCreateEmbeddedRequest() { } this.TestMode = testMode; this.Title = title; this.UseTextTags = useTextTags; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; this.PopulateAutoFillFields = populateAutoFillFields; this.ExpiresAt = expiresAt; } @@ -267,6 +269,13 @@ public static SignatureRequestCreateEmbeddedRequest Init(string jsonData) [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] public bool UseTextTags { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. /// @@ -311,6 +320,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); sb.Append("}\n"); @@ -464,6 +474,10 @@ public bool Equals(SignatureRequestCreateEmbeddedRequest input) this.UseTextTags == input.UseTextTags || this.UseTextTags.Equals(input.UseTextTags) ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) + ) && ( this.PopulateAutoFillFields == input.PopulateAutoFillFields || this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) @@ -557,6 +571,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); if (this.ExpiresAt != null) { @@ -751,6 +766,13 @@ public List GetOpenApiTypes() Value = UseTextTags, }); types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); + types.Add(new OpenApiType() { Name = "populate_auto_fill_fields", Property = "PopulateAutoFillFields", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs index 68a03290b..7c1c63da3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditEmbeddedRequest.cs @@ -63,9 +63,10 @@ protected SignatureRequestEditEmbeddedRequest() { } /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public SignatureRequestEditEmbeddedRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool ignoreTextTagsExtractionErrors = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -95,6 +96,7 @@ protected SignatureRequestEditEmbeddedRequest() { } this.TestMode = testMode; this.Title = title; this.UseTextTags = useTextTags; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; this.PopulateAutoFillFields = populateAutoFillFields; this.ExpiresAt = expiresAt; } @@ -267,6 +269,13 @@ public static SignatureRequestEditEmbeddedRequest Init(string jsonData) [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] public bool UseTextTags { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. /// @@ -311,6 +320,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); sb.Append("}\n"); @@ -464,6 +474,10 @@ public bool Equals(SignatureRequestEditEmbeddedRequest input) this.UseTextTags == input.UseTextTags || this.UseTextTags.Equals(input.UseTextTags) ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) + ) && ( this.PopulateAutoFillFields == input.PopulateAutoFillFields || this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) @@ -557,6 +571,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); if (this.ExpiresAt != null) { @@ -751,6 +766,13 @@ public List GetOpenApiTypes() Value = UseTextTags, }); types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); + types.Add(new OpenApiType() { Name = "populate_auto_fill_fields", Property = "PopulateAutoFillFields", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs index 585c78c47..fb5da5e24 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestEditRequest.cs @@ -65,8 +65,9 @@ protected SignatureRequestEditRequest() { } /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) + public SignatureRequestEditRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool ignoreTextTagsExtractionErrors = false, int? expiresAt = default(int?)) { this.Files = files; @@ -93,6 +94,7 @@ protected SignatureRequestEditRequest() { } this.TestMode = testMode; this.Title = title; this.UseTextTags = useTextTags; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; this.ExpiresAt = expiresAt; } @@ -278,6 +280,13 @@ public static SignatureRequestEditRequest Init(string jsonData) [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] public bool UseTextTags { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. /// @@ -317,6 +326,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -478,6 +488,10 @@ public bool Equals(SignatureRequestEditRequest input) this.UseTextTags == input.UseTextTags || this.UseTextTags.Equals(input.UseTextTags) ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) + ) && ( this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && @@ -572,6 +586,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); if (this.ExpiresAt != null) { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); @@ -779,6 +794,13 @@ public List GetOpenApiTypes() Value = UseTextTags, }); types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); + types.Add(new OpenApiType() { Name = "expires_at", Property = "ExpiresAt", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs index 9719a297a..234deb520 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/SignatureRequestSendRequest.cs @@ -66,8 +66,9 @@ protected SignatureRequestSendRequest() { } /// Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. (default to false). + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.. - public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, int? expiresAt = default(int?)) + public SignatureRequestSendRequest(List files = default(List), List fileUrls = default(List), List signers = default(List), List groupedSigners = default(List), bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool isQualifiedSignature = false, bool isEid = false, string message = default(string), Dictionary metadata = default(Dictionary), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, string title = default(string), bool useTextTags = false, bool ignoreTextTagsExtractionErrors = false, int? expiresAt = default(int?)) { this.Files = files; @@ -95,6 +96,7 @@ protected SignatureRequestSendRequest() { } this.TestMode = testMode; this.Title = title; this.UseTextTags = useTextTags; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; this.ExpiresAt = expiresAt; } @@ -288,6 +290,13 @@ public static SignatureRequestSendRequest Init(string jsonData) [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] public bool UseTextTags { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. /// @@ -328,6 +337,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -493,6 +503,10 @@ public bool Equals(SignatureRequestSendRequest input) this.UseTextTags == input.UseTextTags || this.UseTextTags.Equals(input.UseTextTags) ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) + ) && ( this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && @@ -588,6 +602,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); if (this.ExpiresAt != null) { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); @@ -802,6 +817,13 @@ public List GetOpenApiTypes() Value = UseTextTags, }); types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); + types.Add(new OpenApiType() { Name = "expires_at", Property = "ExpiresAt", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs index 4220dc5df..09a355e6a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftRequest.cs @@ -66,7 +66,8 @@ protected TemplateCreateEmbeddedDraftRequest() { } /// Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). (default to false). - public TemplateCreateEmbeddedDraftRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), bool showPreview = false, bool showProgressStepper = true, List signerRoles = default(List), bool skipMeNow = false, string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). + public TemplateCreateEmbeddedDraftRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerRoles = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), bool showPreview = false, bool showProgressStepper = true, List signerRoles = default(List), bool skipMeNow = false, string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false, bool ignoreTextTagsExtractionErrors = false) { // to ensure "clientId" is required (not null) @@ -99,6 +100,7 @@ protected TemplateCreateEmbeddedDraftRequest() { } this.TestMode = testMode; this.Title = title; this.UsePreexistingFields = usePreexistingFields; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; } /// @@ -290,6 +292,13 @@ public static TemplateCreateEmbeddedDraftRequest Init(string jsonData) [DataMember(Name = "use_preexisting_fields", EmitDefaultValue = true)] public bool UsePreexistingFields { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// Returns the string presentation of the object /// @@ -323,6 +332,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UsePreexistingFields: ").Append(UsePreexistingFields).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -483,6 +493,10 @@ public bool Equals(TemplateCreateEmbeddedDraftRequest input) ( this.UsePreexistingFields == input.UsePreexistingFields || this.UsePreexistingFields.Equals(input.UsePreexistingFields) + ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) ); } @@ -568,6 +582,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UsePreexistingFields.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); return hashCode; } } @@ -771,6 +786,13 @@ public List GetOpenApiTypes() Type = "bool", Value = UsePreexistingFields, }); + types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs index 5db1a03e2..f8e060316 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateRequest.cs @@ -59,7 +59,8 @@ protected TemplateCreateRequest() { } /// Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. (default to false). /// The title you want to assign to the SignatureRequest.. /// Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). (default to false). - public TemplateCreateRequest(List files = default(List), List fileUrls = default(List), bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signerRoles = default(List), string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false) + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). + public TemplateCreateRequest(List files = default(List), List fileUrls = default(List), bool allowReassign = false, List attachments = default(List), List ccRoles = default(List), string clientId = default(string), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), List mergeFields = default(List), string message = default(string), Dictionary metadata = default(Dictionary), List signerRoles = default(List), string subject = default(string), bool testMode = false, string title = default(string), bool usePreexistingFields = false, bool ignoreTextTagsExtractionErrors = false) { // to ensure "formFieldsPerDocument" is required (not null) @@ -90,6 +91,7 @@ protected TemplateCreateRequest() { } this.TestMode = testMode; this.Title = title; this.UsePreexistingFields = usePreexistingFields; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; } /// @@ -233,6 +235,13 @@ public static TemplateCreateRequest Init(string jsonData) [DataMember(Name = "use_preexisting_fields", EmitDefaultValue = true)] public bool UsePreexistingFields { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// Returns the string presentation of the object /// @@ -259,6 +268,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" UsePreexistingFields: ").Append(UsePreexistingFields).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -390,6 +400,10 @@ public bool Equals(TemplateCreateRequest input) ( this.UsePreexistingFields == input.UsePreexistingFields || this.UsePreexistingFields.Equals(input.UsePreexistingFields) + ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) ); } @@ -465,6 +479,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Title.GetHashCode(); } hashCode = (hashCode * 59) + this.UsePreexistingFields.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); return hashCode; } } @@ -619,6 +634,13 @@ public List GetOpenApiTypes() Type = "bool", Value = UsePreexistingFields, }); + types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs index 00ece6767..85cbaf101 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateEmbeddedRequest.cs @@ -102,9 +102,10 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } /// The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. (default to TypeEnum.RequestSignature). /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.. - public UnclaimedDraftCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerPage = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = default(bool), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), bool testMode = false, TypeEnum? type = TypeEnum.RequestSignature, bool usePreexistingFields = false, bool useTextTags = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) + public UnclaimedDraftCreateEmbeddedRequest(List files = default(List), List fileUrls = default(List), bool allowCcs = true, bool allowDecline = false, bool allowReassign = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubEditorOptions editorOptions = default(SubEditorOptions), SubFieldOptions fieldOptions = default(SubFieldOptions), bool forceSignerPage = false, bool forceSubjectMessage = false, List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, bool holdRequest = false, bool isForEmbeddedSigning = false, string message = default(string), Dictionary metadata = default(Dictionary), string requesterEmailAddress = default(string), string requestingRedirectUrl = default(string), bool showPreview = default(bool), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), bool skipMeNow = false, string subject = default(string), bool testMode = false, TypeEnum? type = TypeEnum.RequestSignature, bool usePreexistingFields = false, bool useTextTags = false, bool ignoreTextTagsExtractionErrors = false, bool populateAutoFillFields = false, int? expiresAt = default(int?)) { // to ensure "clientId" is required (not null) @@ -151,6 +152,7 @@ protected UnclaimedDraftCreateEmbeddedRequest() { } this.Type = type; this.UsePreexistingFields = usePreexistingFields; this.UseTextTags = useTextTags; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; this.PopulateAutoFillFields = populateAutoFillFields; this.ExpiresAt = expiresAt; } @@ -399,6 +401,13 @@ public static UnclaimedDraftCreateEmbeddedRequest Init(string jsonData) [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] public bool UseTextTags { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. /// @@ -455,6 +464,7 @@ public override string ToString() sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" UsePreexistingFields: ").Append(UsePreexistingFields).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append(" PopulateAutoFillFields: ").Append(PopulateAutoFillFields).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); sb.Append("}\n"); @@ -657,6 +667,10 @@ public bool Equals(UnclaimedDraftCreateEmbeddedRequest input) this.UseTextTags == input.UseTextTags || this.UseTextTags.Equals(input.UseTextTags) ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) + ) && ( this.PopulateAutoFillFields == input.PopulateAutoFillFields || this.PopulateAutoFillFields.Equals(input.PopulateAutoFillFields) @@ -768,6 +782,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Type.GetHashCode(); hashCode = (hashCode * 59) + this.UsePreexistingFields.GetHashCode(); hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); hashCode = (hashCode * 59) + this.PopulateAutoFillFields.GetHashCode(); if (this.ExpiresAt != null) { @@ -1040,6 +1055,13 @@ public List GetOpenApiTypes() Value = UseTextTags, }); types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); + types.Add(new OpenApiType() { Name = "populate_auto_fill_fields", Property = "PopulateAutoFillFields", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs index 065407e17..e60cf6136 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/UnclaimedDraftCreateRequest.cs @@ -91,8 +91,9 @@ protected UnclaimedDraftCreateRequest() { } /// The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. (required). /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). /// Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. (default to false). + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. (default to false). /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.. - public UnclaimedDraftCreateRequest(List files = default(List), List fileUrls = default(List), bool allowDecline = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, TypeEnum type = default(TypeEnum), bool usePreexistingFields = false, bool useTextTags = false, int? expiresAt = default(int?)) + public UnclaimedDraftCreateRequest(List files = default(List), List fileUrls = default(List), bool allowDecline = false, List attachments = default(List), List ccEmailAddresses = default(List), string clientId = default(string), List customFields = default(List), SubFieldOptions fieldOptions = default(SubFieldOptions), List formFieldGroups = default(List), List formFieldRules = default(List), List formFieldsPerDocument = default(List), bool hideTextTags = false, string message = default(string), Dictionary metadata = default(Dictionary), bool showProgressStepper = true, List signers = default(List), SubSigningOptions signingOptions = default(SubSigningOptions), string signingRedirectUrl = default(string), string subject = default(string), bool testMode = false, TypeEnum type = default(TypeEnum), bool usePreexistingFields = false, bool useTextTags = false, bool ignoreTextTagsExtractionErrors = false, int? expiresAt = default(int?)) { this.Type = type; @@ -118,6 +119,7 @@ protected UnclaimedDraftCreateRequest() { } this.TestMode = testMode; this.UsePreexistingFields = usePreexistingFields; this.UseTextTags = useTextTags; + this.IgnoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; this.ExpiresAt = expiresAt; } @@ -289,6 +291,13 @@ public static UnclaimedDraftCreateRequest Init(string jsonData) [DataMember(Name = "use_text_tags", EmitDefaultValue = true)] public bool UseTextTags { get; set; } + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + /// + /// Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + [DataMember(Name = "ignore_text_tags_extraction_errors", EmitDefaultValue = true)] + public bool IgnoreTextTagsExtractionErrors { get; set; } + /// /// When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. /// @@ -327,6 +336,7 @@ public override string ToString() sb.Append(" TestMode: ").Append(TestMode).Append("\n"); sb.Append(" UsePreexistingFields: ").Append(UsePreexistingFields).Append("\n"); sb.Append(" UseTextTags: ").Append(UseTextTags).Append("\n"); + sb.Append(" IgnoreTextTagsExtractionErrors: ").Append(IgnoreTextTagsExtractionErrors).Append("\n"); sb.Append(" ExpiresAt: ").Append(ExpiresAt).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -481,6 +491,10 @@ public bool Equals(UnclaimedDraftCreateRequest input) this.UseTextTags == input.UseTextTags || this.UseTextTags.Equals(input.UseTextTags) ) && + ( + this.IgnoreTextTagsExtractionErrors == input.IgnoreTextTagsExtractionErrors || + this.IgnoreTextTagsExtractionErrors.Equals(input.IgnoreTextTagsExtractionErrors) + ) && ( this.ExpiresAt == input.ExpiresAt || (this.ExpiresAt != null && @@ -568,6 +582,7 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.TestMode.GetHashCode(); hashCode = (hashCode * 59) + this.UsePreexistingFields.GetHashCode(); hashCode = (hashCode * 59) + this.UseTextTags.GetHashCode(); + hashCode = (hashCode * 59) + this.IgnoreTextTagsExtractionErrors.GetHashCode(); if (this.ExpiresAt != null) { hashCode = (hashCode * 59) + this.ExpiresAt.GetHashCode(); @@ -762,6 +777,13 @@ public List GetOpenApiTypes() Value = UseTextTags, }); types.Add(new OpenApiType() + { + Name = "ignore_text_tags_extraction_errors", + Property = "IgnoreTextTagsExtractionErrors", + Type = "bool", + Value = IgnoreTextTagsExtractionErrors, + }); + types.Add(new OpenApiType() { Name = "expires_at", Property = "ExpiresAt", diff --git a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md index 383f8a8f3..5c9fb864a 100644 --- a/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestCreateEmbeddedRequest.md @@ -30,6 +30,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md index dd8b06061..6bceed341 100644 --- a/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditEmbeddedRequest.md @@ -30,6 +30,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v1/docs/SignatureRequestEditRequest.md b/sdks/java-v1/docs/SignatureRequestEditRequest.md index b4705fe97..382ad28b7 100644 --- a/sdks/java-v1/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v1/docs/SignatureRequestEditRequest.md @@ -32,6 +32,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v1/docs/SignatureRequestSendRequest.md b/sdks/java-v1/docs/SignatureRequestSendRequest.md index a34284aa2..ae4a65938 100644 --- a/sdks/java-v1/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v1/docs/SignatureRequestSendRequest.md @@ -33,6 +33,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md index 05f2497fc..667458f8d 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftRequest.md @@ -33,6 +33,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/TemplateCreateRequest.md b/sdks/java-v1/docs/TemplateCreateRequest.md index 5f99510d9..11576ad07 100644 --- a/sdks/java-v1/docs/TemplateCreateRequest.md +++ b/sdks/java-v1/docs/TemplateCreateRequest.md @@ -26,6 +26,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md index aab362d77..531a6b0ed 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -42,6 +42,7 @@ | `type` | [```TypeEnum```](#TypeEnum) | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | | | `usePreexistingFields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `useTextTags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

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

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md index f23c6f4ba..9b2de66db 100644 --- a/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v1/docs/UnclaimedDraftCreateRequest.md @@ -31,6 +31,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `usePreexistingFields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `useTextTags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 8e1987c37..619de9b1b 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java @@ -50,6 +50,7 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @@ -126,6 +127,10 @@ public class SignatureRequestCreateEmbeddedRequest { public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; @javax.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; @javax.annotation.Nullable private Boolean populateAutoFillFields = false; @@ -802,6 +807,31 @@ public void setUseTextTags(@javax.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } + public SignatureRequestCreateEmbeddedRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + public SignatureRequestCreateEmbeddedRequest populateAutoFillFields( @javax.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; @@ -903,6 +933,9 @@ public boolean equals(Object o) { && Objects.equals(this.title, signatureRequestCreateEmbeddedRequest.title) && Objects.equals( this.useTextTags, signatureRequestCreateEmbeddedRequest.useTextTags) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + signatureRequestCreateEmbeddedRequest.ignoreTextTagsExtractionErrors) && Objects.equals( this.populateAutoFillFields, signatureRequestCreateEmbeddedRequest.populateAutoFillFields) @@ -934,6 +967,7 @@ public int hashCode() { testMode, title, useTextTags, + ignoreTextTagsExtractionErrors, populateAutoFillFields, expiresAt); } @@ -966,6 +1000,9 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append(" populateAutoFillFields: ") .append(toIndentedString(populateAutoFillFields)) .append("\n"); @@ -1410,6 +1447,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (populateAutoFillFields != null) { if (isFileTypeOrListOfFiles(populateAutoFillFields)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index 752946426..7e81329a4 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -50,6 +50,7 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @@ -126,6 +127,10 @@ public class SignatureRequestEditEmbeddedRequest { public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; @javax.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; @javax.annotation.Nullable private Boolean populateAutoFillFields = false; @@ -798,6 +803,31 @@ public void setUseTextTags(@javax.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } + public SignatureRequestEditEmbeddedRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + public SignatureRequestEditEmbeddedRequest populateAutoFillFields( @javax.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; @@ -896,6 +926,9 @@ public boolean equals(Object o) { && Objects.equals(this.testMode, signatureRequestEditEmbeddedRequest.testMode) && Objects.equals(this.title, signatureRequestEditEmbeddedRequest.title) && Objects.equals(this.useTextTags, signatureRequestEditEmbeddedRequest.useTextTags) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + signatureRequestEditEmbeddedRequest.ignoreTextTagsExtractionErrors) && Objects.equals( this.populateAutoFillFields, signatureRequestEditEmbeddedRequest.populateAutoFillFields) @@ -927,6 +960,7 @@ public int hashCode() { testMode, title, useTextTags, + ignoreTextTagsExtractionErrors, populateAutoFillFields, expiresAt); } @@ -959,6 +993,9 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append(" populateAutoFillFields: ") .append(toIndentedString(populateAutoFillFields)) .append("\n"); @@ -1403,6 +1440,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (populateAutoFillFields != null) { if (isFileTypeOrListOfFiles(populateAutoFillFields)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 85a485a07..16d8e42b8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -52,6 +52,7 @@ SignatureRequestEditRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditRequest.JSON_PROPERTY_TITLE, SignatureRequestEditRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT }) @javax.annotation.Generated( @@ -133,6 +134,10 @@ public class SignatureRequestEditRequest { public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; @javax.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; @@ -844,6 +849,31 @@ public void setUseTextTags(@javax.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } + public SignatureRequestEditRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + public SignatureRequestEditRequest expiresAt(@javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; @@ -906,6 +936,9 @@ public boolean equals(Object o) { && Objects.equals(this.testMode, signatureRequestEditRequest.testMode) && Objects.equals(this.title, signatureRequestEditRequest.title) && Objects.equals(this.useTextTags, signatureRequestEditRequest.useTextTags) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + signatureRequestEditRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt); } @@ -936,6 +969,7 @@ public int hashCode() { testMode, title, useTextTags, + ignoreTextTagsExtractionErrors, expiresAt); } @@ -971,6 +1005,9 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1452,6 +1489,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index 912bf0f17..9f66585f6 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -53,6 +53,7 @@ SignatureRequestSendRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestSendRequest.JSON_PROPERTY_TITLE, SignatureRequestSendRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestSendRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT }) @javax.annotation.Generated( @@ -137,6 +138,10 @@ public class SignatureRequestSendRequest { public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; @javax.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; @@ -879,6 +884,31 @@ public void setUseTextTags(@javax.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } + public SignatureRequestSendRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + public SignatureRequestSendRequest expiresAt(@javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; @@ -943,6 +973,9 @@ public boolean equals(Object o) { && Objects.equals(this.testMode, signatureRequestSendRequest.testMode) && Objects.equals(this.title, signatureRequestSendRequest.title) && Objects.equals(this.useTextTags, signatureRequestSendRequest.useTextTags) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + signatureRequestSendRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt); } @@ -974,6 +1007,7 @@ public int hashCode() { testMode, title, useTextTags, + ignoreTextTagsExtractionErrors, expiresAt); } @@ -1012,6 +1046,9 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1515,6 +1552,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index 0061bf657..df96f4263 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java @@ -52,7 +52,8 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_SUBJECT, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TITLE, - TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -135,6 +136,10 @@ public class TemplateCreateEmbeddedDraftRequest { public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; @javax.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public TemplateCreateEmbeddedDraftRequest() {} /** @@ -850,6 +855,31 @@ public void setUsePreexistingFields(@javax.annotation.Nullable Boolean usePreexi this.usePreexistingFields = usePreexistingFields; } + public TemplateCreateEmbeddedDraftRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + /** Return true if this TemplateCreateEmbeddedDraftRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -899,7 +929,10 @@ public boolean equals(Object o) { && Objects.equals(this.title, templateCreateEmbeddedDraftRequest.title) && Objects.equals( this.usePreexistingFields, - templateCreateEmbeddedDraftRequest.usePreexistingFields); + templateCreateEmbeddedDraftRequest.usePreexistingFields) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + templateCreateEmbeddedDraftRequest.ignoreTextTagsExtractionErrors); } @Override @@ -929,7 +962,8 @@ public int hashCode() { subject, testMode, title, - usePreexistingFields); + usePreexistingFields, + ignoreTextTagsExtractionErrors); } @Override @@ -969,6 +1003,9 @@ public String toString() { sb.append(" usePreexistingFields: ") .append(toIndentedString(usePreexistingFields)) .append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append("}"); return sb.toString(); } @@ -1475,6 +1512,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index 8e3815a5b..2a54368c5 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java @@ -45,7 +45,8 @@ TemplateCreateRequest.JSON_PROPERTY_SUBJECT, TemplateCreateRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateRequest.JSON_PROPERTY_TITLE, - TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -108,6 +109,10 @@ public class TemplateCreateRequest { public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; @javax.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public TemplateCreateRequest() {} /** @@ -649,6 +654,31 @@ public void setUsePreexistingFields(@javax.annotation.Nullable Boolean usePreexi this.usePreexistingFields = usePreexistingFields; } + public TemplateCreateRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + /** Return true if this TemplateCreateRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -678,7 +708,10 @@ public boolean equals(Object o) { && Objects.equals(this.testMode, templateCreateRequest.testMode) && Objects.equals(this.title, templateCreateRequest.title) && Objects.equals( - this.usePreexistingFields, templateCreateRequest.usePreexistingFields); + this.usePreexistingFields, templateCreateRequest.usePreexistingFields) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + templateCreateRequest.ignoreTextTagsExtractionErrors); } @Override @@ -701,7 +734,8 @@ public int hashCode() { subject, testMode, title, - usePreexistingFields); + usePreexistingFields, + ignoreTextTagsExtractionErrors); } @Override @@ -730,6 +764,9 @@ public String toString() { sb.append(" usePreexistingFields: ") .append(toIndentedString(usePreexistingFields)) .append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append("}"); return sb.toString(); } @@ -1092,6 +1129,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 4b758039a..18ad7b825 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java @@ -64,6 +64,7 @@ UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_TYPE, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @@ -211,6 +212,10 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; @javax.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; @javax.annotation.Nullable private Boolean populateAutoFillFields = false; @@ -1171,6 +1176,31 @@ public void setUseTextTags(@javax.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } + public UnclaimedDraftCreateEmbeddedRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + public UnclaimedDraftCreateEmbeddedRequest populateAutoFillFields( @javax.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; @@ -1297,6 +1327,9 @@ public boolean equals(Object o) { this.usePreexistingFields, unclaimedDraftCreateEmbeddedRequest.usePreexistingFields) && Objects.equals(this.useTextTags, unclaimedDraftCreateEmbeddedRequest.useTextTags) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + unclaimedDraftCreateEmbeddedRequest.ignoreTextTagsExtractionErrors) && Objects.equals( this.populateAutoFillFields, unclaimedDraftCreateEmbeddedRequest.populateAutoFillFields) @@ -1340,6 +1373,7 @@ public int hashCode() { type, usePreexistingFields, useTextTags, + ignoreTextTagsExtractionErrors, populateAutoFillFields, expiresAt); } @@ -1398,6 +1432,9 @@ public String toString() { .append(toIndentedString(usePreexistingFields)) .append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append(" populateAutoFillFields: ") .append(toIndentedString(populateAutoFillFields)) .append("\n"); @@ -2100,6 +2137,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (populateAutoFillFields != null) { if (isFileTypeOrListOfFiles(populateAutoFillFields)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 0b0b6b61b..3bd0086dc 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java @@ -53,6 +53,7 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_TEST_MODE, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_TEXT_TAGS, + UnclaimedDraftCreateRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, UnclaimedDraftCreateRequest.JSON_PROPERTY_EXPIRES_AT }) @javax.annotation.Generated( @@ -167,6 +168,10 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; @javax.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = + "ignore_text_tags_extraction_errors"; + @javax.annotation.Nullable private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @javax.annotation.Nullable private Integer expiresAt; @@ -852,6 +857,31 @@ public void setUseTextTags(@javax.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } + public UnclaimedDraftCreateRequest ignoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags + * extraction. Defaults to `false`. + * + * @return ignoreTextTagsExtractionErrors + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors( + @javax.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + public UnclaimedDraftCreateRequest expiresAt(@javax.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; @@ -916,6 +946,9 @@ public boolean equals(Object o) { && Objects.equals( this.usePreexistingFields, unclaimedDraftCreateRequest.usePreexistingFields) && Objects.equals(this.useTextTags, unclaimedDraftCreateRequest.useTextTags) + && Objects.equals( + this.ignoreTextTagsExtractionErrors, + unclaimedDraftCreateRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.expiresAt, unclaimedDraftCreateRequest.expiresAt); } @@ -945,6 +978,7 @@ public int hashCode() { testMode, usePreexistingFields, useTextTags, + ignoreTextTagsExtractionErrors, expiresAt); } @@ -983,6 +1017,9 @@ public String toString() { .append(toIndentedString(usePreexistingFields)) .append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ") + .append(toIndentedString(ignoreTextTagsExtractionErrors)) + .append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1450,6 +1487,30 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) + || ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) + || ignoreTextTagsExtractionErrors.getClass().equals(String.class) + || ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for (int i = 0; i < getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put( + "ignore_text_tags_extraction_errors[" + i + "]", + getFromList(ignoreTextTagsExtractionErrors, i)); + } + } else { + map.put( + "ignore_text_tags_extraction_errors", + JSON.getDefault() + .getMapper() + .writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md index 383f8a8f3..5c9fb864a 100644 --- a/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestCreateEmbeddedRequest.md @@ -30,6 +30,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md index dd8b06061..6bceed341 100644 --- a/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditEmbeddedRequest.md @@ -30,6 +30,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v2/docs/SignatureRequestEditRequest.md b/sdks/java-v2/docs/SignatureRequestEditRequest.md index b4705fe97..382ad28b7 100644 --- a/sdks/java-v2/docs/SignatureRequestEditRequest.md +++ b/sdks/java-v2/docs/SignatureRequestEditRequest.md @@ -32,6 +32,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v2/docs/SignatureRequestSendRequest.md b/sdks/java-v2/docs/SignatureRequestSendRequest.md index a34284aa2..ae4a65938 100644 --- a/sdks/java-v2/docs/SignatureRequestSendRequest.md +++ b/sdks/java-v2/docs/SignatureRequestSendRequest.md @@ -33,6 +33,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md index 05f2497fc..667458f8d 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftRequest.md @@ -33,6 +33,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/TemplateCreateRequest.md b/sdks/java-v2/docs/TemplateCreateRequest.md index 5f99510d9..11576ad07 100644 --- a/sdks/java-v2/docs/TemplateCreateRequest.md +++ b/sdks/java-v2/docs/TemplateCreateRequest.md @@ -26,6 +26,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md index aab362d77..531a6b0ed 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -42,6 +42,7 @@ | `type` | [```TypeEnum```](#TypeEnum) | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | | | `usePreexistingFields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `useTextTags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `populateAutoFillFields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

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

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md index f23c6f4ba..9b2de66db 100644 --- a/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/java-v2/docs/UnclaimedDraftCreateRequest.md @@ -31,6 +31,7 @@ | `testMode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | | | `usePreexistingFields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | | `useTextTags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | | +| `ignoreTextTagsExtractionErrors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | | | `expiresAt` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 3002deccd..ef2c003f9 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java @@ -69,6 +69,7 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @@ -163,6 +164,10 @@ public class SignatureRequestCreateEmbeddedRequest { @jakarta.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; @@ -827,6 +832,31 @@ public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { } + public SignatureRequestCreateEmbeddedRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + public SignatureRequestCreateEmbeddedRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; return this; @@ -911,13 +941,14 @@ public boolean equals(Object o) { Objects.equals(this.testMode, signatureRequestCreateEmbeddedRequest.testMode) && Objects.equals(this.title, signatureRequestCreateEmbeddedRequest.title) && Objects.equals(this.useTextTags, signatureRequestCreateEmbeddedRequest.useTextTags) && + Objects.equals(this.ignoreTextTagsExtractionErrors, signatureRequestCreateEmbeddedRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.populateAutoFillFields, signatureRequestCreateEmbeddedRequest.populateAutoFillFields) && Objects.equals(this.expiresAt, signatureRequestCreateEmbeddedRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, ignoreTextTagsExtractionErrors, populateAutoFillFields, expiresAt); } @Override @@ -946,6 +977,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); @@ -1374,6 +1406,25 @@ public Map createFormData() throws ApiException { map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (populateAutoFillFields != null) { if (isFileTypeOrListOfFiles(populateAutoFillFields)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java index 9a40b64a2..67cae5bee 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -69,6 +69,7 @@ SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TITLE, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @@ -163,6 +164,10 @@ public class SignatureRequestEditEmbeddedRequest { @jakarta.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; @@ -827,6 +832,31 @@ public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { } + public SignatureRequestEditEmbeddedRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + public SignatureRequestEditEmbeddedRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; return this; @@ -911,13 +941,14 @@ public boolean equals(Object o) { Objects.equals(this.testMode, signatureRequestEditEmbeddedRequest.testMode) && Objects.equals(this.title, signatureRequestEditEmbeddedRequest.title) && Objects.equals(this.useTextTags, signatureRequestEditEmbeddedRequest.useTextTags) && + Objects.equals(this.ignoreTextTagsExtractionErrors, signatureRequestEditEmbeddedRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedRequest.populateAutoFillFields) && Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, ignoreTextTagsExtractionErrors, populateAutoFillFields, expiresAt); } @Override @@ -946,6 +977,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); @@ -1374,6 +1406,25 @@ public Map createFormData() throws ApiException { map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (populateAutoFillFields != null) { if (isFileTypeOrListOfFiles(populateAutoFillFields)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java index 9ca66e0f5..719186cec 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -71,6 +71,7 @@ SignatureRequestEditRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestEditRequest.JSON_PROPERTY_TITLE, SignatureRequestEditRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @@ -172,6 +173,10 @@ public class SignatureRequestEditRequest { @jakarta.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @jakarta.annotation.Nullable private Integer expiresAt; @@ -882,6 +887,31 @@ public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { } + public SignatureRequestEditRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + public SignatureRequestEditRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; @@ -943,12 +973,13 @@ public boolean equals(Object o) { Objects.equals(this.testMode, signatureRequestEditRequest.testMode) && Objects.equals(this.title, signatureRequestEditRequest.title) && Objects.equals(this.useTextTags, signatureRequestEditRequest.useTextTags) && + Objects.equals(this.ignoreTextTagsExtractionErrors, signatureRequestEditRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, ignoreTextTagsExtractionErrors, expiresAt); } @Override @@ -979,6 +1010,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1444,6 +1476,25 @@ public Map createFormData() throws ApiException { map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index 89792b2b5..7e5620f4f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -72,6 +72,7 @@ SignatureRequestSendRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestSendRequest.JSON_PROPERTY_TITLE, SignatureRequestSendRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestSendRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @@ -178,6 +179,10 @@ public class SignatureRequestSendRequest { @jakarta.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @jakarta.annotation.Nullable private Integer expiresAt; @@ -917,6 +922,31 @@ public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { } + public SignatureRequestSendRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + public SignatureRequestSendRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; @@ -979,12 +1009,13 @@ public boolean equals(Object o) { Objects.equals(this.testMode, signatureRequestSendRequest.testMode) && Objects.equals(this.title, signatureRequestSendRequest.title) && Objects.equals(this.useTextTags, signatureRequestSendRequest.useTextTags) && + Objects.equals(this.ignoreTextTagsExtractionErrors, signatureRequestSendRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.expiresAt, signatureRequestSendRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isQualifiedSignature, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, ignoreTextTagsExtractionErrors, expiresAt); } @Override @@ -1016,6 +1047,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1500,6 +1532,25 @@ public Map createFormData() throws ApiException { map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index d7786dade..816e47436 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java @@ -70,7 +70,8 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_SUBJECT, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TITLE, - TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -175,6 +176,10 @@ public class TemplateCreateEmbeddedDraftRequest { @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public TemplateCreateEmbeddedDraftRequest() { } @@ -898,6 +903,31 @@ public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePree } + public TemplateCreateEmbeddedDraftRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + /** * Return true if this TemplateCreateEmbeddedDraftRequest object is equal to o. */ @@ -934,12 +964,13 @@ public boolean equals(Object o) { Objects.equals(this.subject, templateCreateEmbeddedDraftRequest.subject) && Objects.equals(this.testMode, templateCreateEmbeddedDraftRequest.testMode) && Objects.equals(this.title, templateCreateEmbeddedDraftRequest.title) && - Objects.equals(this.usePreexistingFields, templateCreateEmbeddedDraftRequest.usePreexistingFields); + Objects.equals(this.usePreexistingFields, templateCreateEmbeddedDraftRequest.usePreexistingFields) && + Objects.equals(this.ignoreTextTagsExtractionErrors, templateCreateEmbeddedDraftRequest.ignoreTextTagsExtractionErrors); } @Override public int hashCode() { - return Objects.hash(clientId, files, fileUrls, allowCcs, allowReassign, attachments, ccRoles, editorOptions, fieldOptions, forceSignerRoles, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, mergeFields, message, metadata, showPreview, showProgressStepper, signerRoles, skipMeNow, subject, testMode, title, usePreexistingFields); + return Objects.hash(clientId, files, fileUrls, allowCcs, allowReassign, attachments, ccRoles, editorOptions, fieldOptions, forceSignerRoles, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, mergeFields, message, metadata, showPreview, showProgressStepper, signerRoles, skipMeNow, subject, testMode, title, usePreexistingFields, ignoreTextTagsExtractionErrors); } @Override @@ -971,6 +1002,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" usePreexistingFields: ").append(toIndentedString(usePreexistingFields)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1454,6 +1486,25 @@ public Map createFormData() throws ApiException { map.put("use_preexisting_fields", JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index 2a353e0ec..b5cedf1d8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java @@ -62,7 +62,8 @@ TemplateCreateRequest.JSON_PROPERTY_SUBJECT, TemplateCreateRequest.JSON_PROPERTY_TEST_MODE, TemplateCreateRequest.JSON_PROPERTY_TITLE, - TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS + TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, + TemplateCreateRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -139,6 +140,10 @@ public class TemplateCreateRequest { @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public TemplateCreateRequest() { } @@ -687,6 +692,31 @@ public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePree } + public TemplateCreateRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + /** * Return true if this TemplateCreateRequest object is equal to o. */ @@ -716,12 +746,13 @@ public boolean equals(Object o) { Objects.equals(this.subject, templateCreateRequest.subject) && Objects.equals(this.testMode, templateCreateRequest.testMode) && Objects.equals(this.title, templateCreateRequest.title) && - Objects.equals(this.usePreexistingFields, templateCreateRequest.usePreexistingFields); + Objects.equals(this.usePreexistingFields, templateCreateRequest.usePreexistingFields) && + Objects.equals(this.ignoreTextTagsExtractionErrors, templateCreateRequest.ignoreTextTagsExtractionErrors); } @Override public int hashCode() { - return Objects.hash(formFieldsPerDocument, signerRoles, files, fileUrls, allowReassign, attachments, ccRoles, clientId, fieldOptions, formFieldGroups, formFieldRules, mergeFields, message, metadata, subject, testMode, title, usePreexistingFields); + return Objects.hash(formFieldsPerDocument, signerRoles, files, fileUrls, allowReassign, attachments, ccRoles, clientId, fieldOptions, formFieldGroups, formFieldRules, mergeFields, message, metadata, subject, testMode, title, usePreexistingFields, ignoreTextTagsExtractionErrors); } @Override @@ -746,6 +777,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" usePreexistingFields: ").append(toIndentedString(usePreexistingFields)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append("}"); return sb.toString(); } @@ -1096,6 +1128,25 @@ public Map createFormData() throws ApiException { map.put("use_preexisting_fields", JSON.getDefault().getMapper().writeValueAsString(usePreexistingFields)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 0c762b684..7c24adca0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java @@ -81,6 +81,7 @@ UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_TYPE, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) @@ -258,6 +259,10 @@ public static TypeEnum fromValue(String value) { @jakarta.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; @@ -1214,6 +1219,31 @@ public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { } + public UnclaimedDraftCreateEmbeddedRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + public UnclaimedDraftCreateEmbeddedRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; return this; @@ -1310,13 +1340,14 @@ public boolean equals(Object o) { Objects.equals(this.type, unclaimedDraftCreateEmbeddedRequest.type) && Objects.equals(this.usePreexistingFields, unclaimedDraftCreateEmbeddedRequest.usePreexistingFields) && Objects.equals(this.useTextTags, unclaimedDraftCreateEmbeddedRequest.useTextTags) && + Objects.equals(this.ignoreTextTagsExtractionErrors, unclaimedDraftCreateEmbeddedRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.populateAutoFillFields, unclaimedDraftCreateEmbeddedRequest.populateAutoFillFields) && Objects.equals(this.expiresAt, unclaimedDraftCreateEmbeddedRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(clientId, requesterEmailAddress, files, fileUrls, allowCcs, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, editorOptions, fieldOptions, forceSignerPage, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, holdRequest, isForEmbeddedSigning, message, metadata, requestingRedirectUrl, showPreview, showProgressStepper, signers, signingOptions, signingRedirectUrl, skipMeNow, subject, testMode, type, usePreexistingFields, useTextTags, populateAutoFillFields, expiresAt); + return Objects.hash(clientId, requesterEmailAddress, files, fileUrls, allowCcs, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, editorOptions, fieldOptions, forceSignerPage, forceSubjectMessage, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, holdRequest, isForEmbeddedSigning, message, metadata, requestingRedirectUrl, showPreview, showProgressStepper, signers, signingOptions, signingRedirectUrl, skipMeNow, subject, testMode, type, usePreexistingFields, useTextTags, ignoreTextTagsExtractionErrors, populateAutoFillFields, expiresAt); } @Override @@ -1357,6 +1388,7 @@ public String toString() { sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" usePreexistingFields: ").append(toIndentedString(usePreexistingFields)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); @@ -2013,6 +2045,25 @@ public Map createFormData() throws ApiException { map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (populateAutoFillFields != null) { if (isFileTypeOrListOfFiles(populateAutoFillFields)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 58a73751a..28d132508 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java @@ -69,6 +69,7 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_TEST_MODE, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS, UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_TEXT_TAGS, + UnclaimedDraftCreateRequest.JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS, UnclaimedDraftCreateRequest.JSON_PROPERTY_EXPIRES_AT }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @@ -201,6 +202,10 @@ public static TypeEnum fromValue(String value) { @jakarta.annotation.Nullable private Boolean useTextTags = false; + public static final String JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS = "ignore_text_tags_extraction_errors"; + @jakarta.annotation.Nullable + private Boolean ignoreTextTagsExtractionErrors = false; + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; @jakarta.annotation.Nullable private Integer expiresAt; @@ -878,6 +883,31 @@ public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { } + public UnclaimedDraftCreateRequest ignoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + return this; + } + + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * @return ignoreTextTagsExtractionErrors + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIgnoreTextTagsExtractionErrors() { + return ignoreTextTagsExtractionErrors; + } + + + @JsonProperty(JSON_PROPERTY_IGNORE_TEXT_TAGS_EXTRACTION_ERRORS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreTextTagsExtractionErrors(@jakarta.annotation.Nullable Boolean ignoreTextTagsExtractionErrors) { + this.ignoreTextTagsExtractionErrors = ignoreTextTagsExtractionErrors; + } + + public UnclaimedDraftCreateRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; @@ -938,12 +968,13 @@ public boolean equals(Object o) { Objects.equals(this.testMode, unclaimedDraftCreateRequest.testMode) && Objects.equals(this.usePreexistingFields, unclaimedDraftCreateRequest.usePreexistingFields) && Objects.equals(this.useTextTags, unclaimedDraftCreateRequest.useTextTags) && + Objects.equals(this.ignoreTextTagsExtractionErrors, unclaimedDraftCreateRequest.ignoreTextTagsExtractionErrors) && Objects.equals(this.expiresAt, unclaimedDraftCreateRequest.expiresAt); } @Override public int hashCode() { - return Objects.hash(type, files, fileUrls, allowDecline, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, showProgressStepper, signers, signingOptions, signingRedirectUrl, subject, testMode, usePreexistingFields, useTextTags, expiresAt); + return Objects.hash(type, files, fileUrls, allowDecline, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, showProgressStepper, signers, signingOptions, signingRedirectUrl, subject, testMode, usePreexistingFields, useTextTags, ignoreTextTagsExtractionErrors, expiresAt); } @Override @@ -973,6 +1004,7 @@ public String toString() { sb.append(" testMode: ").append(toIndentedString(testMode)).append("\n"); sb.append(" usePreexistingFields: ").append(toIndentedString(usePreexistingFields)).append("\n"); sb.append(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" ignoreTextTagsExtractionErrors: ").append(toIndentedString(ignoreTextTagsExtractionErrors)).append("\n"); sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); sb.append("}"); return sb.toString(); @@ -1419,6 +1451,25 @@ public Map createFormData() throws ApiException { map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); } } + if (ignoreTextTagsExtractionErrors != null) { + if (isFileTypeOrListOfFiles(ignoreTextTagsExtractionErrors)) { + fileTypeFound = true; + } + + if (ignoreTextTagsExtractionErrors.getClass().equals(java.io.File.class) || + ignoreTextTagsExtractionErrors.getClass().equals(Integer.class) || + ignoreTextTagsExtractionErrors.getClass().equals(String.class) || + ignoreTextTagsExtractionErrors.getClass().isEnum()) { + map.put("ignore_text_tags_extraction_errors", ignoreTextTagsExtractionErrors); + } else if (isListOfFile(ignoreTextTagsExtractionErrors)) { + for(int i = 0; i< getListSize(ignoreTextTagsExtractionErrors); i++) { + map.put("ignore_text_tags_extraction_errors[" + i + "]", getFromList(ignoreTextTagsExtractionErrors, i)); + } + } + else { + map.put("ignore_text_tags_extraction_errors", JSON.getDefault().getMapper().writeValueAsString(ignoreTextTagsExtractionErrors)); + } + } if (expiresAt != null) { if (isFileTypeOrListOfFiles(expiresAt)) { fileTypeFound = true; diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 28db3c0fc..6887f5b9c 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -19572,6 +19572,10 @@ var SignatureRequestCreateEmbeddedRequest = class _SignatureRequestCreateEmbedde * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ this["useTextTags"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; /** * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ @@ -19692,6 +19696,11 @@ var SignatureRequestCreateEmbeddedRequest = class _SignatureRequestCreateEmbedde baseName: "use_text_tags", type: "boolean" }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" + }, { name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", @@ -19849,6 +19858,10 @@ var SignatureRequestEditEmbeddedRequest = class _SignatureRequestEditEmbeddedReq * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ this["useTextTags"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; /** * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ @@ -19969,6 +19982,11 @@ var SignatureRequestEditEmbeddedRequest = class _SignatureRequestEditEmbeddedReq baseName: "use_text_tags", type: "boolean" }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" + }, { name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", @@ -20130,6 +20148,10 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ this["useTextTags"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; } static { this.discriminator = void 0; @@ -20256,6 +20278,11 @@ var SignatureRequestEditRequest = class _SignatureRequestEditRequest { baseName: "use_text_tags", type: "boolean" }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" + }, { name: "expiresAt", baseName: "expires_at", @@ -21397,6 +21424,10 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ this["useTextTags"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; } static { this.discriminator = void 0; @@ -21528,6 +21559,11 @@ var SignatureRequestSendRequest = class _SignatureRequestSendRequest { baseName: "use_text_tags", type: "boolean" }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" + }, { name: "expiresAt", baseName: "expires_at", @@ -23995,6 +24031,10 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque * Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). */ this["usePreexistingFields"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; } static { this.discriminator = void 0; @@ -24125,6 +24165,11 @@ var TemplateCreateEmbeddedDraftRequest = class _TemplateCreateEmbeddedDraftReque name: "usePreexistingFields", baseName: "use_preexisting_fields", type: "boolean" + }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" } ]; } @@ -24227,6 +24272,10 @@ var TemplateCreateRequest = class _TemplateCreateRequest { * Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). */ this["usePreexistingFields"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; } static { this.discriminator = void 0; @@ -24322,6 +24371,11 @@ var TemplateCreateRequest = class _TemplateCreateRequest { name: "usePreexistingFields", baseName: "use_preexisting_fields", type: "boolean" + }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" } ]; } @@ -26006,6 +26060,10 @@ var UnclaimedDraftCreateEmbeddedRequest = class _UnclaimedDraftCreateEmbeddedReq * Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. */ this["useTextTags"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; /** * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ @@ -26186,6 +26244,11 @@ var UnclaimedDraftCreateEmbeddedRequest = class _UnclaimedDraftCreateEmbeddedReq baseName: "use_text_tags", type: "boolean" }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" + }, { name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", @@ -26469,6 +26532,10 @@ var UnclaimedDraftCreateRequest = class _UnclaimedDraftCreateRequest { * Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. */ this["useTextTags"] = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + this["ignoreTextTagsExtractionErrors"] = false; } static { this.discriminator = void 0; @@ -26590,6 +26657,11 @@ var UnclaimedDraftCreateRequest = class _UnclaimedDraftCreateRequest { baseName: "use_text_tags", type: "boolean" }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean" + }, { name: "expiresAt", baseName: "expires_at", diff --git a/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md index d8cbf1583..60e0f1ee5 100644 --- a/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestCreateEmbeddedRequest.md @@ -28,6 +28,7 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md index bcc66ecf9..55cf08069 100644 --- a/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditEmbeddedRequest.md @@ -28,6 +28,7 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/node/docs/model/SignatureRequestEditRequest.md b/sdks/node/docs/model/SignatureRequestEditRequest.md index 3e29f398f..6c494975a 100644 --- a/sdks/node/docs/model/SignatureRequestEditRequest.md +++ b/sdks/node/docs/model/SignatureRequestEditRequest.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/SignatureRequestSendRequest.md b/sdks/node/docs/model/SignatureRequestSendRequest.md index 656e79f9f..1bd407100 100644 --- a/sdks/node/docs/model/SignatureRequestSendRequest.md +++ b/sdks/node/docs/model/SignatureRequestSendRequest.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `useTextTags` | ```boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md index 0a6d8c813..c35c48814 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftRequest.md @@ -31,5 +31,6 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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/docs/model/TemplateCreateRequest.md b/sdks/node/docs/model/TemplateCreateRequest.md index 738ed648d..8725a2266 100644 --- a/sdks/node/docs/model/TemplateCreateRequest.md +++ b/sdks/node/docs/model/TemplateCreateRequest.md @@ -24,5 +24,6 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `usePreexistingFields` | ```boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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/docs/model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md index 444d8d77c..495157463 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateEmbeddedRequest.md @@ -40,6 +40,7 @@ Name | Type | Description | Notes | `type` | ```string``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to TypeEnum.RequestSignature] | | `usePreexistingFields` | ```boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `useTextTags` | ```boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populateAutoFillFields` | ```boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

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

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md index 255cbe395..81f324bac 100644 --- a/sdks/node/docs/model/UnclaimedDraftCreateRequest.md +++ b/sdks/node/docs/model/UnclaimedDraftCreateRequest.md @@ -29,6 +29,7 @@ Name | Type | Description | Notes | `testMode` | ```boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `usePreexistingFields` | ```boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `useTextTags` | ```boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `ignoreTextTagsExtractionErrors` | ```boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expiresAt` | ```number``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | [[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/signatureRequestCreateEmbeddedRequest.ts b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts index 774cbec6c..f71d2cbe5 100644 --- a/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestCreateEmbeddedRequest.ts @@ -116,6 +116,10 @@ export class SignatureRequestCreateEmbeddedRequest { * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ "useTextTags"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; /** * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ @@ -238,6 +242,11 @@ export class SignatureRequestCreateEmbeddedRequest { baseName: "use_text_tags", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, { name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", diff --git a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts index 78b05c0ac..62ceecc89 100644 --- a/sdks/node/model/signatureRequestEditEmbeddedRequest.ts +++ b/sdks/node/model/signatureRequestEditEmbeddedRequest.ts @@ -116,6 +116,10 @@ export class SignatureRequestEditEmbeddedRequest { * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ "useTextTags"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; /** * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ @@ -238,6 +242,11 @@ export class SignatureRequestEditEmbeddedRequest { baseName: "use_text_tags", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, { name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", diff --git a/sdks/node/model/signatureRequestEditRequest.ts b/sdks/node/model/signatureRequestEditRequest.ts index 5f079203c..4da0adde8 100644 --- a/sdks/node/model/signatureRequestEditRequest.ts +++ b/sdks/node/model/signatureRequestEditRequest.ts @@ -124,6 +124,10 @@ export class SignatureRequestEditRequest { * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ "useTextTags"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; /** * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. */ @@ -252,6 +256,11 @@ export class SignatureRequestEditRequest { baseName: "use_text_tags", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, { name: "expiresAt", baseName: "expires_at", diff --git a/sdks/node/model/signatureRequestSendRequest.ts b/sdks/node/model/signatureRequestSendRequest.ts index f18588a35..9efeba7ac 100644 --- a/sdks/node/model/signatureRequestSendRequest.ts +++ b/sdks/node/model/signatureRequestSendRequest.ts @@ -130,6 +130,10 @@ export class SignatureRequestSendRequest { * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. */ "useTextTags"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; /** * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. */ @@ -263,6 +267,11 @@ export class SignatureRequestSendRequest { baseName: "use_text_tags", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, { name: "expiresAt", baseName: "expires_at", diff --git a/sdks/node/model/templateCreateEmbeddedDraftRequest.ts b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts index 657fa7c86..3c48c2e5a 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftRequest.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftRequest.ts @@ -127,6 +127,10 @@ export class TemplateCreateEmbeddedDraftRequest { * Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). */ "usePreexistingFields"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; static discriminator: string | undefined = undefined; @@ -256,6 +260,11 @@ export class TemplateCreateEmbeddedDraftRequest { baseName: "use_preexisting_fields", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateCreateRequest.ts b/sdks/node/model/templateCreateRequest.ts index 66701c09e..5a2292bf3 100644 --- a/sdks/node/model/templateCreateRequest.ts +++ b/sdks/node/model/templateCreateRequest.ts @@ -101,6 +101,10 @@ export class TemplateCreateRequest { * Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). */ "usePreexistingFields"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; static discriminator: string | undefined = undefined; @@ -195,6 +199,11 @@ export class TemplateCreateRequest { baseName: "use_preexisting_fields", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts index 950f3c5c1..9d8388cbe 100644 --- a/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateEmbeddedRequest.ts @@ -165,6 +165,10 @@ export class UnclaimedDraftCreateEmbeddedRequest { * Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. */ "useTextTags"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; /** * Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer\'s information during signing. **NOTE:** Keep your signer\'s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. */ @@ -347,6 +351,11 @@ export class UnclaimedDraftCreateEmbeddedRequest { baseName: "use_text_tags", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, { name: "populateAutoFillFields", baseName: "populate_auto_fill_fields", diff --git a/sdks/node/model/unclaimedDraftCreateRequest.ts b/sdks/node/model/unclaimedDraftCreateRequest.ts index cac96a626..b93e4d95a 100644 --- a/sdks/node/model/unclaimedDraftCreateRequest.ts +++ b/sdks/node/model/unclaimedDraftCreateRequest.ts @@ -122,6 +122,10 @@ export class UnclaimedDraftCreateRequest { * Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. */ "useTextTags"?: boolean = false; + /** + * Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + */ + "ignoreTextTagsExtractionErrors"?: boolean = false; /** * When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. */ @@ -245,6 +249,11 @@ export class UnclaimedDraftCreateRequest { baseName: "use_text_tags", type: "boolean", }, + { + name: "ignoreTextTagsExtractionErrors", + baseName: "ignore_text_tags_extraction_errors", + type: "boolean", + }, { name: "expiresAt", baseName: "expires_at", diff --git a/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts b/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts index a26931cca..5c9c7b9a0 100644 --- a/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts +++ b/sdks/node/types/model/signatureRequestCreateEmbeddedRequest.d.ts @@ -33,6 +33,7 @@ export declare class SignatureRequestCreateEmbeddedRequest { "testMode"?: boolean; "title"?: string; "useTextTags"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; "populateAutoFillFields"?: boolean; "expiresAt"?: number | null; static discriminator: string | undefined; diff --git a/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts index 6c2691435..dbccb8ffc 100644 --- a/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditEmbeddedRequest.d.ts @@ -33,6 +33,7 @@ export declare class SignatureRequestEditEmbeddedRequest { "testMode"?: boolean; "title"?: string; "useTextTags"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; "populateAutoFillFields"?: boolean; "expiresAt"?: number | null; static discriminator: string | undefined; diff --git a/sdks/node/types/model/signatureRequestEditRequest.d.ts b/sdks/node/types/model/signatureRequestEditRequest.d.ts index 91a01f76c..041c1c572 100644 --- a/sdks/node/types/model/signatureRequestEditRequest.d.ts +++ b/sdks/node/types/model/signatureRequestEditRequest.d.ts @@ -35,6 +35,7 @@ export declare class SignatureRequestEditRequest { "testMode"?: boolean; "title"?: string; "useTextTags"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; "expiresAt"?: number | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/signatureRequestSendRequest.d.ts b/sdks/node/types/model/signatureRequestSendRequest.d.ts index cd862694b..65e86dbb2 100644 --- a/sdks/node/types/model/signatureRequestSendRequest.d.ts +++ b/sdks/node/types/model/signatureRequestSendRequest.d.ts @@ -36,6 +36,7 @@ export declare class SignatureRequestSendRequest { "testMode"?: boolean; "title"?: string; "useTextTags"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; "expiresAt"?: number | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts b/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts index a527c0e84..2d26c15d3 100644 --- a/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts +++ b/sdks/node/types/model/templateCreateEmbeddedDraftRequest.d.ts @@ -35,6 +35,7 @@ export declare class TemplateCreateEmbeddedDraftRequest { "testMode"?: boolean; "title"?: string; "usePreexistingFields"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateRequest.d.ts b/sdks/node/types/model/templateCreateRequest.d.ts index b81d319ea..ccc4ca91b 100644 --- a/sdks/node/types/model/templateCreateRequest.d.ts +++ b/sdks/node/types/model/templateCreateRequest.d.ts @@ -27,6 +27,7 @@ export declare class TemplateCreateRequest { "testMode"?: boolean; "title"?: string; "usePreexistingFields"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts b/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts index 1b48b08e1..f68e09ba4 100644 --- a/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts +++ b/sdks/node/types/model/unclaimedDraftCreateEmbeddedRequest.d.ts @@ -45,6 +45,7 @@ export declare class UnclaimedDraftCreateEmbeddedRequest { "type"?: UnclaimedDraftCreateEmbeddedRequest.TypeEnum; "usePreexistingFields"?: boolean; "useTextTags"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; "populateAutoFillFields"?: boolean; "expiresAt"?: number | null; static discriminator: string | undefined; diff --git a/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts b/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts index fd54bdc79..a4513ef2e 100644 --- a/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts +++ b/sdks/node/types/model/unclaimedDraftCreateRequest.d.ts @@ -33,6 +33,7 @@ export declare class UnclaimedDraftCreateRequest { "testMode"?: boolean; "usePreexistingFields"?: boolean; "useTextTags"?: boolean; + "ignoreTextTagsExtractionErrors"?: boolean; "expiresAt"?: number | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md index a953bcbc2..639123f60 100644 --- a/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestCreateEmbeddedRequest.md @@ -28,6 +28,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md index b2567ac3f..772db7145 100644 --- a/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditEmbeddedRequest.md @@ -28,6 +28,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/php/docs/Model/SignatureRequestEditRequest.md b/sdks/php/docs/Model/SignatureRequestEditRequest.md index bd308cf42..e4139fe04 100644 --- a/sdks/php/docs/Model/SignatureRequestEditRequest.md +++ b/sdks/php/docs/Model/SignatureRequestEditRequest.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/SignatureRequestSendRequest.md b/sdks/php/docs/Model/SignatureRequestSendRequest.md index bad47fcfc..2d3e247a8 100644 --- a/sdks/php/docs/Model/SignatureRequestSendRequest.md +++ b/sdks/php/docs/Model/SignatureRequestSendRequest.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md index d9ef188de..26e5e7d41 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftRequest.md @@ -31,5 +31,6 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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/docs/Model/TemplateCreateRequest.md b/sdks/php/docs/Model/TemplateCreateRequest.md index 1a4b677f1..44696baa1 100644 --- a/sdks/php/docs/Model/TemplateCreateRequest.md +++ b/sdks/php/docs/Model/TemplateCreateRequest.md @@ -24,5 +24,6 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```string``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md index 4d9b2c5c4..161bdf331 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateEmbeddedRequest.md @@ -40,6 +40,7 @@ Name | Type | Description | Notes | `type` | ```string``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to 'request_signature'] | | `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

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

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md index afcb4a779..493645760 100644 --- a/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md +++ b/sdks/php/docs/Model/UnclaimedDraftCreateRequest.md @@ -29,6 +29,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php index 1a7cda140..1da278f10 100644 --- a/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestCreateEmbeddedRequest.php @@ -80,6 +80,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'test_mode' => 'bool', 'title' => 'string', 'use_text_tags' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', 'populate_auto_fill_fields' => 'bool', 'expires_at' => 'int', ]; @@ -114,6 +115,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'test_mode' => null, 'title' => null, 'use_text_tags' => null, + 'ignore_text_tags_extraction_errors' => null, 'populate_auto_fill_fields' => null, 'expires_at' => null, ]; @@ -146,6 +148,7 @@ class SignatureRequestCreateEmbeddedRequest implements ModelInterface, ArrayAcce 'test_mode' => false, 'title' => false, 'use_text_tags' => false, + 'ignore_text_tags_extraction_errors' => false, 'populate_auto_fill_fields' => false, 'expires_at' => true, ]; @@ -250,6 +253,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_text_tags' => 'use_text_tags', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', 'expires_at' => 'expires_at', ]; @@ -282,6 +286,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', 'expires_at' => 'setExpiresAt', ]; @@ -314,6 +319,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', 'expires_at' => 'getExpiresAt', ]; @@ -396,6 +402,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); } @@ -1081,6 +1088,33 @@ public function setUseTextTags(?bool $use_text_tags) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Gets populate_auto_fill_fields * diff --git a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php index 2795f5a2b..3a1902156 100644 --- a/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditEmbeddedRequest.php @@ -80,6 +80,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'test_mode' => 'bool', 'title' => 'string', 'use_text_tags' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', 'populate_auto_fill_fields' => 'bool', 'expires_at' => 'int', ]; @@ -114,6 +115,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'test_mode' => null, 'title' => null, 'use_text_tags' => null, + 'ignore_text_tags_extraction_errors' => null, 'populate_auto_fill_fields' => null, 'expires_at' => null, ]; @@ -146,6 +148,7 @@ class SignatureRequestEditEmbeddedRequest implements ModelInterface, ArrayAccess 'test_mode' => false, 'title' => false, 'use_text_tags' => false, + 'ignore_text_tags_extraction_errors' => false, 'populate_auto_fill_fields' => false, 'expires_at' => true, ]; @@ -250,6 +253,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_text_tags' => 'use_text_tags', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', 'expires_at' => 'expires_at', ]; @@ -282,6 +286,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', 'expires_at' => 'setExpiresAt', ]; @@ -314,6 +319,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', 'expires_at' => 'getExpiresAt', ]; @@ -396,6 +402,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); } @@ -1081,6 +1088,33 @@ public function setUseTextTags(?bool $use_text_tags) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Gets populate_auto_fill_fields * diff --git a/sdks/php/src/Model/SignatureRequestEditRequest.php b/sdks/php/src/Model/SignatureRequestEditRequest.php index 1e16db897..b23ca78fc 100644 --- a/sdks/php/src/Model/SignatureRequestEditRequest.php +++ b/sdks/php/src/Model/SignatureRequestEditRequest.php @@ -82,6 +82,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => 'bool', 'title' => 'string', 'use_text_tags' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', 'expires_at' => 'int', ]; @@ -117,6 +118,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => null, 'title' => null, 'use_text_tags' => null, + 'ignore_text_tags_extraction_errors' => null, 'expires_at' => null, ]; @@ -150,6 +152,7 @@ class SignatureRequestEditRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => false, 'title' => false, 'use_text_tags' => false, + 'ignore_text_tags_extraction_errors' => false, 'expires_at' => true, ]; @@ -255,6 +258,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_text_tags' => 'use_text_tags', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', 'expires_at' => 'expires_at', ]; @@ -288,6 +292,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', 'expires_at' => 'setExpiresAt', ]; @@ -321,6 +326,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', 'expires_at' => 'getExpiresAt', ]; @@ -404,6 +410,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); } @@ -1139,6 +1146,33 @@ public function setUseTextTags(?bool $use_text_tags) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Gets expires_at * diff --git a/sdks/php/src/Model/SignatureRequestSendRequest.php b/sdks/php/src/Model/SignatureRequestSendRequest.php index a0f74237e..823c7eaa7 100644 --- a/sdks/php/src/Model/SignatureRequestSendRequest.php +++ b/sdks/php/src/Model/SignatureRequestSendRequest.php @@ -83,6 +83,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => 'bool', 'title' => 'string', 'use_text_tags' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', 'expires_at' => 'int', ]; @@ -119,6 +120,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => null, 'title' => null, 'use_text_tags' => null, + 'ignore_text_tags_extraction_errors' => null, 'expires_at' => null, ]; @@ -153,6 +155,7 @@ class SignatureRequestSendRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => false, 'title' => false, 'use_text_tags' => false, + 'ignore_text_tags_extraction_errors' => false, 'expires_at' => true, ]; @@ -259,6 +262,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_text_tags' => 'use_text_tags', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', 'expires_at' => 'expires_at', ]; @@ -293,6 +297,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_text_tags' => 'setUseTextTags', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', 'expires_at' => 'setExpiresAt', ]; @@ -327,6 +332,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_text_tags' => 'getUseTextTags', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', 'expires_at' => 'getExpiresAt', ]; @@ -411,6 +417,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); } @@ -1175,6 +1182,33 @@ public function setUseTextTags(?bool $use_text_tags) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Gets expires_at * diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php index 9d151a16f..b8bf15992 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftRequest.php @@ -83,6 +83,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'test_mode' => 'bool', 'title' => 'string', 'use_preexisting_fields' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', ]; /** @@ -118,6 +119,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'test_mode' => null, 'title' => null, 'use_preexisting_fields' => null, + 'ignore_text_tags_extraction_errors' => null, ]; /** @@ -151,6 +153,7 @@ class TemplateCreateEmbeddedDraftRequest implements ModelInterface, ArrayAccess, 'test_mode' => false, 'title' => false, 'use_preexisting_fields' => false, + 'ignore_text_tags_extraction_errors' => false, ]; /** @@ -256,6 +259,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_preexisting_fields' => 'use_preexisting_fields', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', ]; /** @@ -289,6 +293,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_preexisting_fields' => 'setUsePreexistingFields', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', ]; /** @@ -322,6 +327,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_preexisting_fields' => 'getUsePreexistingFields', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', ]; /** @@ -405,6 +411,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_preexisting_fields', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); } /** @@ -1161,6 +1168,33 @@ public function setUsePreexistingFields(?bool $use_preexisting_fields) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateCreateRequest.php b/sdks/php/src/Model/TemplateCreateRequest.php index 87e69a2be..52625c60b 100644 --- a/sdks/php/src/Model/TemplateCreateRequest.php +++ b/sdks/php/src/Model/TemplateCreateRequest.php @@ -76,6 +76,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'test_mode' => 'bool', 'title' => 'string', 'use_preexisting_fields' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', ]; /** @@ -104,6 +105,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'test_mode' => null, 'title' => null, 'use_preexisting_fields' => null, + 'ignore_text_tags_extraction_errors' => null, ]; /** @@ -130,6 +132,7 @@ class TemplateCreateRequest implements ModelInterface, ArrayAccess, JsonSerializ 'test_mode' => false, 'title' => false, 'use_preexisting_fields' => false, + 'ignore_text_tags_extraction_errors' => false, ]; /** @@ -228,6 +231,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'title' => 'title', 'use_preexisting_fields' => 'use_preexisting_fields', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', ]; /** @@ -254,6 +258,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'title' => 'setTitle', 'use_preexisting_fields' => 'setUsePreexistingFields', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', ]; /** @@ -280,6 +285,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'title' => 'getTitle', 'use_preexisting_fields' => 'getUsePreexistingFields', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', ]; /** @@ -356,6 +362,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('use_preexisting_fields', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); } /** @@ -926,6 +933,33 @@ public function setUsePreexistingFields(?bool $use_preexisting_fields) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php index fa78f95e6..2838ed208 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateEmbeddedRequest.php @@ -93,6 +93,7 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'type' => 'string', 'use_preexisting_fields' => 'bool', 'use_text_tags' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', 'populate_auto_fill_fields' => 'bool', 'expires_at' => 'int', ]; @@ -139,6 +140,7 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'type' => null, 'use_preexisting_fields' => null, 'use_text_tags' => null, + 'ignore_text_tags_extraction_errors' => null, 'populate_auto_fill_fields' => null, 'expires_at' => null, ]; @@ -183,6 +185,7 @@ class UnclaimedDraftCreateEmbeddedRequest implements ModelInterface, ArrayAccess 'type' => false, 'use_preexisting_fields' => false, 'use_text_tags' => false, + 'ignore_text_tags_extraction_errors' => false, 'populate_auto_fill_fields' => false, 'expires_at' => true, ]; @@ -299,6 +302,7 @@ public function isNullableSetToNull(string $property): bool 'type' => 'type', 'use_preexisting_fields' => 'use_preexisting_fields', 'use_text_tags' => 'use_text_tags', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', 'populate_auto_fill_fields' => 'populate_auto_fill_fields', 'expires_at' => 'expires_at', ]; @@ -343,6 +347,7 @@ public function isNullableSetToNull(string $property): bool 'type' => 'setType', 'use_preexisting_fields' => 'setUsePreexistingFields', 'use_text_tags' => 'setUseTextTags', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', 'populate_auto_fill_fields' => 'setPopulateAutoFillFields', 'expires_at' => 'setExpiresAt', ]; @@ -387,6 +392,7 @@ public function isNullableSetToNull(string $property): bool 'type' => 'getType', 'use_preexisting_fields' => 'getUsePreexistingFields', 'use_text_tags' => 'getUseTextTags', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', 'populate_auto_fill_fields' => 'getPopulateAutoFillFields', 'expires_at' => 'getExpiresAt', ]; @@ -497,6 +503,7 @@ public function __construct(?array $data = null) $this->setIfExists('type', $data ?? [], 'request_signature'); $this->setIfExists('use_preexisting_fields', $data ?? [], false); $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); $this->setIfExists('populate_auto_fill_fields', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); } @@ -1520,6 +1527,33 @@ public function setUseTextTags(?bool $use_text_tags) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Gets populate_auto_fill_fields * diff --git a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php index ed0060400..57d82c5b2 100644 --- a/sdks/php/src/Model/UnclaimedDraftCreateRequest.php +++ b/sdks/php/src/Model/UnclaimedDraftCreateRequest.php @@ -82,6 +82,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => 'bool', 'use_preexisting_fields' => 'bool', 'use_text_tags' => 'bool', + 'ignore_text_tags_extraction_errors' => 'bool', 'expires_at' => 'int', ]; @@ -116,6 +117,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => null, 'use_preexisting_fields' => null, 'use_text_tags' => null, + 'ignore_text_tags_extraction_errors' => null, 'expires_at' => null, ]; @@ -148,6 +150,7 @@ class UnclaimedDraftCreateRequest implements ModelInterface, ArrayAccess, JsonSe 'test_mode' => false, 'use_preexisting_fields' => false, 'use_text_tags' => false, + 'ignore_text_tags_extraction_errors' => false, 'expires_at' => true, ]; @@ -252,6 +255,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'test_mode', 'use_preexisting_fields' => 'use_preexisting_fields', 'use_text_tags' => 'use_text_tags', + 'ignore_text_tags_extraction_errors' => 'ignore_text_tags_extraction_errors', 'expires_at' => 'expires_at', ]; @@ -284,6 +288,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'setTestMode', 'use_preexisting_fields' => 'setUsePreexistingFields', 'use_text_tags' => 'setUseTextTags', + 'ignore_text_tags_extraction_errors' => 'setIgnoreTextTagsExtractionErrors', 'expires_at' => 'setExpiresAt', ]; @@ -316,6 +321,7 @@ public function isNullableSetToNull(string $property): bool 'test_mode' => 'getTestMode', 'use_preexisting_fields' => 'getUsePreexistingFields', 'use_text_tags' => 'getUseTextTags', + 'ignore_text_tags_extraction_errors' => 'getIgnoreTextTagsExtractionErrors', 'expires_at' => 'getExpiresAt', ]; @@ -414,6 +420,7 @@ public function __construct(?array $data = null) $this->setIfExists('test_mode', $data ?? [], false); $this->setIfExists('use_preexisting_fields', $data ?? [], false); $this->setIfExists('use_text_tags', $data ?? [], false); + $this->setIfExists('ignore_text_tags_extraction_errors', $data ?? [], false); $this->setIfExists('expires_at', $data ?? [], null); } @@ -1136,6 +1143,33 @@ public function setUseTextTags(?bool $use_text_tags) return $this; } + /** + * Gets ignore_text_tags_extraction_errors + * + * @return bool|null + */ + public function getIgnoreTextTagsExtractionErrors() + { + return $this->container['ignore_text_tags_extraction_errors']; + } + + /** + * Sets ignore_text_tags_extraction_errors + * + * @param bool|null $ignore_text_tags_extraction_errors Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + * + * @return self + */ + public function setIgnoreTextTagsExtractionErrors(?bool $ignore_text_tags_extraction_errors) + { + if (is_null($ignore_text_tags_extraction_errors)) { + throw new InvalidArgumentException('non-nullable ignore_text_tags_extraction_errors cannot be null'); + } + $this->container['ignore_text_tags_extraction_errors'] = $ignore_text_tags_extraction_errors; + + return $this; + } + /** * Gets expires_at * diff --git a/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index 039735160..79db31de2 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -676,12 +676,14 @@ with ApiClient(configuration) as api_client: files=[ open("./example_signature_request.pdf", "rb").read(), ], - metadata=json.loads(""" + metadata=json.loads( + """ { "custom_id": 1234, "custom_text": "NDA #9" } - """), + """ + ), field_options=field_options, signing_options=signing_options, signers=signers, @@ -1705,12 +1707,14 @@ with ApiClient(configuration) as api_client: files=[ open("./example_signature_request.pdf", "rb").read(), ], - metadata=json.loads(""" + metadata=json.loads( + """ { "custom_id": 1234, "custom_text": "NDA #9" } - """), + """ + ), field_options=field_options, signing_options=signing_options, signers=signers, diff --git a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md index 9f2fe0584..737996807 100644 --- a/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestCreateEmbeddedRequest.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to False] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md index 5165d1da6..ce0318240 100644 --- a/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/python/docs/SignatureRequestEditEmbeddedRequest.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to False] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/python/docs/SignatureRequestEditRequest.md b/sdks/python/docs/SignatureRequestEditRequest.md index a6731f71a..5965a588a 100644 --- a/sdks/python/docs/SignatureRequestEditRequest.md +++ b/sdks/python/docs/SignatureRequestEditRequest.md @@ -29,6 +29,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/SignatureRequestSendRequest.md b/sdks/python/docs/SignatureRequestSendRequest.md index 20db17ad6..26f3ba4dd 100644 --- a/sdks/python/docs/SignatureRequestSendRequest.md +++ b/sdks/python/docs/SignatureRequestSendRequest.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```bool``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | [[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/TemplateCreateEmbeddedDraftRequest.md b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md index c63d97184..69969e708 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftRequest.md @@ -30,6 +30,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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/TemplateCreateRequest.md b/sdks/python/docs/TemplateCreateRequest.md index a5341c381..dc99d24ed 100644 --- a/sdks/python/docs/TemplateCreateRequest.md +++ b/sdks/python/docs/TemplateCreateRequest.md @@ -23,6 +23,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `title` | ```str``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```bool``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [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/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md index 49704d25b..f5a8d88d2 100644 --- a/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -39,6 +39,7 @@ Name | Type | Description | Notes | `type` | ```str``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to 'request_signature'] | | `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to False] | | `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to False] | | `populate_auto_fill_fields` | ```bool``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

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

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/python/docs/UnclaimedDraftCreateRequest.md b/sdks/python/docs/UnclaimedDraftCreateRequest.md index 2d84e6ea7..b30c17022 100644 --- a/sdks/python/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/python/docs/UnclaimedDraftCreateRequest.md @@ -28,6 +28,7 @@ Name | Type | Description | Notes | `test_mode` | ```bool``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to False] | | `use_preexisting_fields` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to False] | | `use_text_tags` | ```bool``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to False] | +| `ignore_text_tags_extraction_errors` | ```bool``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to False] | | `expires_at` | ```int``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/dropbox_sign/api_client.py b/sdks/python/dropbox_sign/api_client.py index 091508190..b90e8029a 100644 --- a/sdks/python/dropbox_sign/api_client.py +++ b/sdks/python/dropbox_sign/api_client.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + import datetime from dateutil.parser import parse from enum import Enum diff --git a/sdks/python/dropbox_sign/configuration.py b/sdks/python/dropbox_sign/configuration.py index fd139f0f1..7247bd547 100644 --- a/sdks/python/dropbox_sign/configuration.py +++ b/sdks/python/dropbox_sign/configuration.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + import copy import http.client as httplib import logging @@ -23,6 +24,7 @@ import urllib3 + JSON_SCHEMA_VALIDATION_KEYWORDS = { "multipleOf", "maximum", diff --git a/sdks/python/dropbox_sign/models/__init__.py b/sdks/python/dropbox_sign/models/__init__.py index bb54e9011..2fd334213 100644 --- a/sdks/python/dropbox_sign/models/__init__.py +++ b/sdks/python/dropbox_sign/models/__init__.py @@ -13,6 +13,7 @@ Do not edit the class manually. """ # noqa: E501 + # import models into model package from dropbox_sign.models.account_create_request import AccountCreateRequest from dropbox_sign.models.account_create_response import AccountCreateResponse diff --git a/sdks/python/dropbox_sign/models/account_create_request.py b/sdks/python/dropbox_sign/models/account_create_request.py index c460b5556..06eb22484 100644 --- a/sdks/python/dropbox_sign/models/account_create_request.py +++ b/sdks/python/dropbox_sign/models/account_create_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_create_response.py b/sdks/python/dropbox_sign/models/account_create_response.py index f1a8dc67b..3bcabfd76 100644 --- a/sdks/python/dropbox_sign/models/account_create_response.py +++ b/sdks/python/dropbox_sign/models/account_create_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_get_response.py b/sdks/python/dropbox_sign/models/account_get_response.py index 4ff285781..9a12adb80 100644 --- a/sdks/python/dropbox_sign/models/account_get_response.py +++ b/sdks/python/dropbox_sign/models/account_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_response.py b/sdks/python/dropbox_sign/models/account_response.py index 94f32163b..9f8beb4d2 100644 --- a/sdks/python/dropbox_sign/models/account_response.py +++ b/sdks/python/dropbox_sign/models/account_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_response_quotas.py b/sdks/python/dropbox_sign/models/account_response_quotas.py index 995d323c7..d2b2ffbb0 100644 --- a/sdks/python/dropbox_sign/models/account_response_quotas.py +++ b/sdks/python/dropbox_sign/models/account_response_quotas.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_response_settings.py b/sdks/python/dropbox_sign/models/account_response_settings.py index b35cdc6f4..18fbe9844 100644 --- a/sdks/python/dropbox_sign/models/account_response_settings.py +++ b/sdks/python/dropbox_sign/models/account_response_settings.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_response_usage.py b/sdks/python/dropbox_sign/models/account_response_usage.py index abf963fcd..6fc759346 100644 --- a/sdks/python/dropbox_sign/models/account_response_usage.py +++ b/sdks/python/dropbox_sign/models/account_response_usage.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_update_request.py b/sdks/python/dropbox_sign/models/account_update_request.py index a502292f3..a0cafd7c4 100644 --- a/sdks/python/dropbox_sign/models/account_update_request.py +++ b/sdks/python/dropbox_sign/models/account_update_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_verify_request.py b/sdks/python/dropbox_sign/models/account_verify_request.py index 794ceb845..39804b0bc 100644 --- a/sdks/python/dropbox_sign/models/account_verify_request.py +++ b/sdks/python/dropbox_sign/models/account_verify_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_verify_response.py b/sdks/python/dropbox_sign/models/account_verify_response.py index bf8198c56..3b0ee8ddf 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response.py +++ b/sdks/python/dropbox_sign/models/account_verify_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/account_verify_response_account.py b/sdks/python/dropbox_sign/models/account_verify_response_account.py index ccd1d403e..98f5fb302 100644 --- a/sdks/python/dropbox_sign/models/account_verify_response_account.py +++ b/sdks/python/dropbox_sign/models/account_verify_response_account.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_create_request.py b/sdks/python/dropbox_sign/models/api_app_create_request.py index cec5bfaa1..788c74a23 100644 --- a/sdks/python/dropbox_sign/models/api_app_create_request.py +++ b/sdks/python/dropbox_sign/models/api_app_create_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_get_response.py b/sdks/python/dropbox_sign/models/api_app_get_response.py index 2933696ba..4337be1ee 100644 --- a/sdks/python/dropbox_sign/models/api_app_get_response.py +++ b/sdks/python/dropbox_sign/models/api_app_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_list_response.py b/sdks/python/dropbox_sign/models/api_app_list_response.py index 6d9b8afc0..98a950e09 100644 --- a/sdks/python/dropbox_sign/models/api_app_list_response.py +++ b/sdks/python/dropbox_sign/models/api_app_list_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_response.py b/sdks/python/dropbox_sign/models/api_app_response.py index cdca9dca8..ad4e87207 100644 --- a/sdks/python/dropbox_sign/models/api_app_response.py +++ b/sdks/python/dropbox_sign/models/api_app_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py index 388f840ac..b078c1a71 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_o_auth.py +++ b/sdks/python/dropbox_sign/models/api_app_response_o_auth.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_response_options.py b/sdks/python/dropbox_sign/models/api_app_response_options.py index 80315b901..ec34ed913 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_options.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py index 95ca83253..d57994800 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_owner_account.py +++ b/sdks/python/dropbox_sign/models/api_app_response_owner_account.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py index a1317662c..b5747219c 100644 --- a/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/api_app_response_white_labeling_options.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/api_app_update_request.py b/sdks/python/dropbox_sign/models/api_app_update_request.py index 393954c1d..7370a7e96 100644 --- a/sdks/python/dropbox_sign/models/api_app_update_request.py +++ b/sdks/python/dropbox_sign/models/api_app_update_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py index 94b90cfa1..9461ccfa6 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py index ded85043d..704089bef 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_get_response_signature_requests.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py index 83c4551c6..8f9791880 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_list_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_response.py index fb95404f8..8d6eeeee0 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py index 288b87cbd..a2eca9737 100644 --- a/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py +++ b/sdks/python/dropbox_sign/models/bulk_send_job_send_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py index 104164cb5..849ebf426 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_request.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py index cf5908634..653ca7c2c 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py index 64c804dbc..67413cb9a 100644 --- a/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_edit_url_response_embedded.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py index cd89bea61..f0e03a177 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py index fb2f95acb..dc7145702 100644 --- a/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py +++ b/sdks/python/dropbox_sign/models/embedded_sign_url_response_embedded.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/error_response.py b/sdks/python/dropbox_sign/models/error_response.py index d71038457..98c6e5a90 100644 --- a/sdks/python/dropbox_sign/models/error_response.py +++ b/sdks/python/dropbox_sign/models/error_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/error_response_error.py b/sdks/python/dropbox_sign/models/error_response_error.py index 4f17bb6ee..6991a0a27 100644 --- a/sdks/python/dropbox_sign/models/error_response_error.py +++ b/sdks/python/dropbox_sign/models/error_response_error.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/event_callback_request.py b/sdks/python/dropbox_sign/models/event_callback_request.py index a5cad664d..f8ac8473d 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request.py +++ b/sdks/python/dropbox_sign/models/event_callback_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event.py b/sdks/python/dropbox_sign/models/event_callback_request_event.py index 67def101d..7f263da42 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py index 39903767b..fee5309d9 100644 --- a/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py +++ b/sdks/python/dropbox_sign/models/event_callback_request_event_metadata.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_get_response.py b/sdks/python/dropbox_sign/models/fax_get_response.py index 0c139a61a..25bf9d2fd 100644 --- a/sdks/python/dropbox_sign/models/fax_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py index 4951c87bd..7a7a92b60 100644 --- a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py index 6249d1459..94df88562 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_country_enum.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import json from enum import Enum diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py index e111091cc..e7994f3f5 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_province_enum.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import json from enum import Enum diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py index 55bbd5703..4d41c9b56 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py index 5f302809e..8cfe5ad2e 100644 --- a/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py +++ b/sdks/python/dropbox_sign/models/fax_line_area_code_get_state_enum.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import json from enum import Enum diff --git a/sdks/python/dropbox_sign/models/fax_line_create_request.py b/sdks/python/dropbox_sign/models/fax_line_create_request.py index 722ecd04c..7a8d88c34 100644 --- a/sdks/python/dropbox_sign/models/fax_line_create_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_create_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_delete_request.py b/sdks/python/dropbox_sign/models/fax_line_delete_request.py index 2ba409b29..9e966098b 100644 --- a/sdks/python/dropbox_sign/models/fax_line_delete_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_delete_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_list_response.py b/sdks/python/dropbox_sign/models/fax_line_list_response.py index 354b03d5e..07581a37e 100644 --- a/sdks/python/dropbox_sign/models/fax_line_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_list_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py index 08e9cb5e3..6021a0c84 100644 --- a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_response.py b/sdks/python/dropbox_sign/models/fax_line_response.py index d85e0c2ac..bb733f4da 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response.py +++ b/sdks/python/dropbox_sign/models/fax_line_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py index d55a0cd7d..8a0676cbe 100644 --- a/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py +++ b/sdks/python/dropbox_sign/models/fax_line_response_fax_line.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_list_response.py b/sdks/python/dropbox_sign/models/fax_list_response.py index 4afc53b6c..99140e3c0 100644 --- a/sdks/python/dropbox_sign/models/fax_list_response.py +++ b/sdks/python/dropbox_sign/models/fax_list_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_response.py b/sdks/python/dropbox_sign/models/fax_response.py index 9f336111d..1648df8e2 100644 --- a/sdks/python/dropbox_sign/models/fax_response.py +++ b/sdks/python/dropbox_sign/models/fax_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_response_transmission.py b/sdks/python/dropbox_sign/models/fax_response_transmission.py index 3d54f4e57..66c613dd2 100644 --- a/sdks/python/dropbox_sign/models/fax_response_transmission.py +++ b/sdks/python/dropbox_sign/models/fax_response_transmission.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/fax_send_request.py b/sdks/python/dropbox_sign/models/fax_send_request.py index 71bdb7b61..c4f0af8c1 100644 --- a/sdks/python/dropbox_sign/models/fax_send_request.py +++ b/sdks/python/dropbox_sign/models/fax_send_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/file_response.py b/sdks/python/dropbox_sign/models/file_response.py index 6e70e7805..434a4f1be 100644 --- a/sdks/python/dropbox_sign/models/file_response.py +++ b/sdks/python/dropbox_sign/models/file_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/file_response_data_uri.py b/sdks/python/dropbox_sign/models/file_response_data_uri.py index 2a535f798..da1384d66 100644 --- a/sdks/python/dropbox_sign/models/file_response_data_uri.py +++ b/sdks/python/dropbox_sign/models/file_response_data_uri.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/list_info_response.py b/sdks/python/dropbox_sign/models/list_info_response.py index 23583a020..cdca4fa28 100644 --- a/sdks/python/dropbox_sign/models/list_info_response.py +++ b/sdks/python/dropbox_sign/models/list_info_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py index 915adcd27..06359f488 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_generate_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py index bd2b11ed2..7a1aa9ae1 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_refresh_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/o_auth_token_response.py b/sdks/python/dropbox_sign/models/o_auth_token_response.py index b56f36a14..4b91161f4 100644 --- a/sdks/python/dropbox_sign/models/o_auth_token_response.py +++ b/sdks/python/dropbox_sign/models/o_auth_token_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/report_create_request.py b/sdks/python/dropbox_sign/models/report_create_request.py index 3d94d8fd6..ec6afec9c 100644 --- a/sdks/python/dropbox_sign/models/report_create_request.py +++ b/sdks/python/dropbox_sign/models/report_create_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/report_create_response.py b/sdks/python/dropbox_sign/models/report_create_response.py index fb309c154..3d781b9bd 100644 --- a/sdks/python/dropbox_sign/models/report_create_response.py +++ b/sdks/python/dropbox_sign/models/report_create_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/report_response.py b/sdks/python/dropbox_sign/models/report_response.py index 40ca150cd..b3ed31ee4 100644 --- a/sdks/python/dropbox_sign/models/report_response.py +++ b/sdks/python/dropbox_sign/models/report_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py index eb69f3375..54fd997c1 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_create_embedded_with_template_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py index c52618e77..54cb9808f 100644 --- a/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_bulk_send_with_template_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py index 2d855ef50..68c784e84 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -134,6 +135,10 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): default=False, description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) populate_auto_fill_fields: Optional[StrictBool] = Field( default=False, description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", @@ -165,6 +170,7 @@ class SignatureRequestCreateEmbeddedRequest(BaseModel): "test_mode", "title", "use_text_tags", + "ignore_text_tags_extraction_errors", "populate_auto_fill_fields", "expires_at", ] @@ -378,6 +384,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_text_tags") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), "populate_auto_fill_fields": ( obj.get("populate_auto_fill_fields") if obj.get("populate_auto_fill_fields") is not None @@ -423,6 +434,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_text_tags": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", "populate_auto_fill_fields": "(bool,)", "expires_at": "(int,)", } diff --git a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py index cb4362e6d..07c2d0cfe 100644 --- a/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_create_embedded_with_template_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py index b5579dbf5..4ea9149f2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -134,6 +135,10 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): default=False, description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) populate_auto_fill_fields: Optional[StrictBool] = Field( default=False, description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", @@ -165,6 +170,7 @@ class SignatureRequestEditEmbeddedRequest(BaseModel): "test_mode", "title", "use_text_tags", + "ignore_text_tags_extraction_errors", "populate_auto_fill_fields", "expires_at", ] @@ -378,6 +384,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_text_tags") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), "populate_auto_fill_fields": ( obj.get("populate_auto_fill_fields") if obj.get("populate_auto_fill_fields") is not None @@ -423,6 +434,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_text_tags": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", "populate_auto_fill_fields": "(bool,)", "expires_at": "(int,)", } diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py index 1c0480924..0061169bb 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_embedded_with_template_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_request.py index 3f622f8d5..181af59ff 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -143,6 +144,10 @@ class SignatureRequestEditRequest(BaseModel): default=False, description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) expires_at: Optional[StrictInt] = Field( default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", @@ -172,6 +177,7 @@ class SignatureRequestEditRequest(BaseModel): "test_mode", "title", "use_text_tags", + "ignore_text_tags_extraction_errors", "expires_at", ] @@ -386,6 +392,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_text_tags") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), "expires_at": obj.get("expires_at"), } ) @@ -428,6 +439,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_text_tags": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", "expires_at": "(int,)", } diff --git a/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py index b7215ec46..1c5bf5a5b 100644 --- a/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_edit_with_template_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_get_response.py b/sdks/python/dropbox_sign/models/signature_request_get_response.py index 10d2b1229..546c12ce3 100644 --- a/sdks/python/dropbox_sign/models/signature_request_get_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_list_response.py b/sdks/python/dropbox_sign/models/signature_request_list_response.py index 4c46fbeef..2df4cbfe3 100644 --- a/sdks/python/dropbox_sign/models/signature_request_list_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_list_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_remind_request.py b/sdks/python/dropbox_sign/models/signature_request_remind_request.py index 3454e86b4..df37e043e 100644 --- a/sdks/python/dropbox_sign/models/signature_request_remind_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_remind_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response.py b/sdks/python/dropbox_sign/models/signature_request_response.py index 4be2db472..7720256b8 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response.py +++ b/sdks/python/dropbox_sign/models/signature_request_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py index 10bb333b1..30af75823 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_attachment.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_attachment.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py index a9ab8ddf5..61ecdd69c 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_base.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py index e10fe7e3a..de55b64e5 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_checkbox.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py index 8f9e4eb1a..48fa24f29 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_text.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py index a8e880e2e..8f715aea2 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_custom_field_type_enum.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import json from enum import Enum diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py index 9353ca349..374d2cc50 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_base.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_base.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py index eaae18cfe..8c4d01dac 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_type_enum.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import json from enum import Enum diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py index 8d3604e42..4e258335d 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py index ba5fd382b..0a25a7ca7 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_checkbox_merge.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py index 4644f1b36..ac09c2600 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_date_signed.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py index f4423cb1b..9eb735261 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_dropdown.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py index d470cd74b..9a5f19055 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_initials.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py index db6f2bd50..38b3cc04a 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_radio.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py index af7eade77..a928d102b 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_signature.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py index 8c9ad56e5..7b5b782e5 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py index 176c4b0cb..13b9591e9 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_data_value_text_merge.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py index ae4f2d9be..9b36e81f6 100644 --- a/sdks/python/dropbox_sign/models/signature_request_response_signatures.py +++ b/sdks/python/dropbox_sign/models/signature_request_response_signatures.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_send_request.py b/sdks/python/dropbox_sign/models/signature_request_send_request.py index 4d781039d..8e61eb922 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -147,6 +148,10 @@ class SignatureRequestSendRequest(BaseModel): default=False, description="Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) expires_at: Optional[StrictInt] = Field( default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.", @@ -177,6 +182,7 @@ class SignatureRequestSendRequest(BaseModel): "test_mode", "title", "use_text_tags", + "ignore_text_tags_extraction_errors", "expires_at", ] @@ -396,6 +402,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_text_tags") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), "expires_at": obj.get("expires_at"), } ) @@ -439,6 +450,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_text_tags": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", "expires_at": "(int,)", } diff --git a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py index f4f4230d1..71cbf1153 100644 --- a/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_send_with_template_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/signature_request_update_request.py b/sdks/python/dropbox_sign/models/signature_request_update_request.py index dcb2de5b9..a5ec1ddc1 100644 --- a/sdks/python/dropbox_sign/models/signature_request_update_request.py +++ b/sdks/python/dropbox_sign/models/signature_request_update_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_attachment.py b/sdks/python/dropbox_sign/models/sub_attachment.py index b2203b2ff..82daeb1f5 100644 --- a/sdks/python/dropbox_sign/models/sub_attachment.py +++ b/sdks/python/dropbox_sign/models/sub_attachment.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py index e1eb782df..899f57701 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py index 396406867..0efdff283 100644 --- a/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_bulk_signer_list_custom_field.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_cc.py b/sdks/python/dropbox_sign/models/sub_cc.py index 02b6b98a4..fb14ef0c0 100644 --- a/sdks/python/dropbox_sign/models/sub_cc.py +++ b/sdks/python/dropbox_sign/models/sub_cc.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_custom_field.py b/sdks/python/dropbox_sign/models/sub_custom_field.py index 952debcec..ec74927d1 100644 --- a/sdks/python/dropbox_sign/models/sub_custom_field.py +++ b/sdks/python/dropbox_sign/models/sub_custom_field.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_editor_options.py b/sdks/python/dropbox_sign/models/sub_editor_options.py index 230af545b..8693cfa02 100644 --- a/sdks/python/dropbox_sign/models/sub_editor_options.py +++ b/sdks/python/dropbox_sign/models/sub_editor_options.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_field_options.py b/sdks/python/dropbox_sign/models/sub_field_options.py index 3a09fad08..12336e67e 100644 --- a/sdks/python/dropbox_sign/models/sub_field_options.py +++ b/sdks/python/dropbox_sign/models/sub_field_options.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_group.py b/sdks/python/dropbox_sign/models/sub_form_field_group.py index 833b04461..a892d2147 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_group.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_group.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule.py b/sdks/python/dropbox_sign/models/sub_form_field_rule.py index f61f9984f..f09ac200c 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py index 033009908..59be4336a 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_action.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py index a045125d6..ff6c5beca 100644 --- a/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py +++ b/sdks/python/dropbox_sign/models/sub_form_field_rule_trigger.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py index 95c07378e..615f1089e 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_base.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py index 4fe8308bf..90538984b 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py index 67d7aa4e5..aa947338f 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_checkbox_merge.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py index 5adeffd8e..583a3a8e6 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_date_signed.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py index b5b13e537..c668c354e 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_dropdown.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py index c01ac7c5c..8865fdc9e 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_font_enum.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import json from enum import Enum diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py index 887a0987d..650d76679 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_hyperlink.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py index faefc0b12..3383d7151 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_initials.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py index 20aca1855..a91bd8688 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_radio.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py index 60c40c746..11a056cb0 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_signature.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py index 0e41d4278..c2e2c3ae4 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py index 152b54856..990c2374a 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_text_merge.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py index 005c16db2..e1d61ca05 100644 --- a/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py +++ b/sdks/python/dropbox_sign/models/sub_form_fields_per_document_type_enum.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import json from enum import Enum diff --git a/sdks/python/dropbox_sign/models/sub_merge_field.py b/sdks/python/dropbox_sign/models/sub_merge_field.py index 9ced5d512..e83058e97 100644 --- a/sdks/python/dropbox_sign/models/sub_merge_field.py +++ b/sdks/python/dropbox_sign/models/sub_merge_field.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_o_auth.py b/sdks/python/dropbox_sign/models/sub_o_auth.py index 6d1014143..2c11784aa 100644 --- a/sdks/python/dropbox_sign/models/sub_o_auth.py +++ b/sdks/python/dropbox_sign/models/sub_o_auth.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_options.py b/sdks/python/dropbox_sign/models/sub_options.py index 75a57ffca..e7965f446 100644 --- a/sdks/python/dropbox_sign/models/sub_options.py +++ b/sdks/python/dropbox_sign/models/sub_options.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py index 9246b829c..a14f315f0 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_grouped_signers.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py index 486d819be..3337098c4 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_signer.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py index 1d41cd463..4d1e239ec 100644 --- a/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_signature_request_template_signer.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_signing_options.py b/sdks/python/dropbox_sign/models/sub_signing_options.py index e1416ed82..7d442bacf 100644 --- a/sdks/python/dropbox_sign/models/sub_signing_options.py +++ b/sdks/python/dropbox_sign/models/sub_signing_options.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_team_response.py b/sdks/python/dropbox_sign/models/sub_team_response.py index 7eb8822ff..5a3b7f74f 100644 --- a/sdks/python/dropbox_sign/models/sub_team_response.py +++ b/sdks/python/dropbox_sign/models/sub_team_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_template_role.py b/sdks/python/dropbox_sign/models/sub_template_role.py index 2024d5c7d..fd407632c 100644 --- a/sdks/python/dropbox_sign/models/sub_template_role.py +++ b/sdks/python/dropbox_sign/models/sub_template_role.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py index aa13619af..318fd8056 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_signer.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py index 98ef0fa2b..a668e9fdc 100644 --- a/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py +++ b/sdks/python/dropbox_sign/models/sub_unclaimed_draft_template_signer.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py index 44acf440e..9fe6f145c 100644 --- a/sdks/python/dropbox_sign/models/sub_white_labeling_options.py +++ b/sdks/python/dropbox_sign/models/sub_white_labeling_options.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_add_member_request.py b/sdks/python/dropbox_sign/models/team_add_member_request.py index afa2232e6..9fa1fbc88 100644 --- a/sdks/python/dropbox_sign/models/team_add_member_request.py +++ b/sdks/python/dropbox_sign/models/team_add_member_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_create_request.py b/sdks/python/dropbox_sign/models/team_create_request.py index 3cec269be..94d38e66b 100644 --- a/sdks/python/dropbox_sign/models/team_create_request.py +++ b/sdks/python/dropbox_sign/models/team_create_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_get_info_response.py b/sdks/python/dropbox_sign/models/team_get_info_response.py index 8a26bdb91..e716e4daa 100644 --- a/sdks/python/dropbox_sign/models/team_get_info_response.py +++ b/sdks/python/dropbox_sign/models/team_get_info_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_get_response.py b/sdks/python/dropbox_sign/models/team_get_response.py index 6740d48f0..3c137e35a 100644 --- a/sdks/python/dropbox_sign/models/team_get_response.py +++ b/sdks/python/dropbox_sign/models/team_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_info_response.py b/sdks/python/dropbox_sign/models/team_info_response.py index 9002a81c6..b10d7cb82 100644 --- a/sdks/python/dropbox_sign/models/team_info_response.py +++ b/sdks/python/dropbox_sign/models/team_info_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_invite_response.py b/sdks/python/dropbox_sign/models/team_invite_response.py index 88a4072f8..0f377202b 100644 --- a/sdks/python/dropbox_sign/models/team_invite_response.py +++ b/sdks/python/dropbox_sign/models/team_invite_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_invites_response.py b/sdks/python/dropbox_sign/models/team_invites_response.py index 1a107ec58..e6171e8fe 100644 --- a/sdks/python/dropbox_sign/models/team_invites_response.py +++ b/sdks/python/dropbox_sign/models/team_invites_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_member_response.py b/sdks/python/dropbox_sign/models/team_member_response.py index 0f6006e32..d59fc5d64 100644 --- a/sdks/python/dropbox_sign/models/team_member_response.py +++ b/sdks/python/dropbox_sign/models/team_member_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_members_response.py b/sdks/python/dropbox_sign/models/team_members_response.py index 0a55ac24d..73ed1c490 100644 --- a/sdks/python/dropbox_sign/models/team_members_response.py +++ b/sdks/python/dropbox_sign/models/team_members_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_parent_response.py b/sdks/python/dropbox_sign/models/team_parent_response.py index 579f0ede7..2478765be 100644 --- a/sdks/python/dropbox_sign/models/team_parent_response.py +++ b/sdks/python/dropbox_sign/models/team_parent_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_remove_member_request.py b/sdks/python/dropbox_sign/models/team_remove_member_request.py index 52c373255..0df67abe9 100644 --- a/sdks/python/dropbox_sign/models/team_remove_member_request.py +++ b/sdks/python/dropbox_sign/models/team_remove_member_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_response.py b/sdks/python/dropbox_sign/models/team_response.py index 3ea2e3524..9f72e11fe 100644 --- a/sdks/python/dropbox_sign/models/team_response.py +++ b/sdks/python/dropbox_sign/models/team_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_sub_teams_response.py b/sdks/python/dropbox_sign/models/team_sub_teams_response.py index a705e74c3..15e0a30c6 100644 --- a/sdks/python/dropbox_sign/models/team_sub_teams_response.py +++ b/sdks/python/dropbox_sign/models/team_sub_teams_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/team_update_request.py b/sdks/python/dropbox_sign/models/team_update_request.py index 360391441..9c4b17e55 100644 --- a/sdks/python/dropbox_sign/models/team_update_request.py +++ b/sdks/python/dropbox_sign/models/team_update_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_add_user_request.py b/sdks/python/dropbox_sign/models/template_add_user_request.py index 06d488773..2e4447115 100644 --- a/sdks/python/dropbox_sign/models/template_add_user_request.py +++ b/sdks/python/dropbox_sign/models/template_add_user_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py index 2c4e52152..cf2090318 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -134,6 +135,10 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): default=False, description="Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) __properties: ClassVar[List[str]] = [ "client_id", "files", @@ -160,6 +165,7 @@ class TemplateCreateEmbeddedDraftRequest(BaseModel): "test_mode", "title", "use_preexisting_fields", + "ignore_text_tags_extraction_errors", ] model_config = ConfigDict( @@ -371,6 +377,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_preexisting_fields") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), } ) return _obj @@ -413,6 +424,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_preexisting_fields": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py index 1bdaf8d4b..fb9a0eb9a 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py index 01c86dde6..3016dce2e 100644 --- a/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_embedded_draft_response_template.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_create_request.py b/sdks/python/dropbox_sign/models/template_create_request.py index 8505936cd..447c5abc8 100644 --- a/sdks/python/dropbox_sign/models/template_create_request.py +++ b/sdks/python/dropbox_sign/models/template_create_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -107,6 +108,10 @@ class TemplateCreateRequest(BaseModel): default=False, description="Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) __properties: ClassVar[List[str]] = [ "form_fields_per_document", "signer_roles", @@ -126,6 +131,7 @@ class TemplateCreateRequest(BaseModel): "test_mode", "title", "use_preexisting_fields", + "ignore_text_tags_extraction_errors", ] model_config = ConfigDict( @@ -301,6 +307,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_preexisting_fields") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), } ) return _obj @@ -336,6 +347,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "title": "(str,)", "use_preexisting_fields": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", } @classmethod diff --git a/sdks/python/dropbox_sign/models/template_create_response.py b/sdks/python/dropbox_sign/models/template_create_response.py index 9654fb9e3..bc5f6c6a2 100644 --- a/sdks/python/dropbox_sign/models/template_create_response.py +++ b/sdks/python/dropbox_sign/models/template_create_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_create_response_template.py b/sdks/python/dropbox_sign/models/template_create_response_template.py index 64051f724..25d9bd7bd 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_get_response.py b/sdks/python/dropbox_sign/models/template_get_response.py index 3f581a17a..10d714c52 100644 --- a/sdks/python/dropbox_sign/models/template_get_response.py +++ b/sdks/python/dropbox_sign/models/template_get_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_list_response.py b/sdks/python/dropbox_sign/models/template_list_response.py index c1b1036c9..5ccaba716 100644 --- a/sdks/python/dropbox_sign/models/template_list_response.py +++ b/sdks/python/dropbox_sign/models/template_list_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_remove_user_request.py b/sdks/python/dropbox_sign/models/template_remove_user_request.py index 27ac14435..44ddbf42e 100644 --- a/sdks/python/dropbox_sign/models/template_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/template_remove_user_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 66d732ef5..667465fff 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index 88c9766c5..d29db33d0 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_account_quota.py b/sdks/python/dropbox_sign/models/template_response_account_quota.py index 89f54c88a..e4fa3668b 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_cc_role.py b/sdks/python/dropbox_sign/models/template_response_cc_role.py index 1f17d0cc1..89a3b4c88 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index a7177287c..d2f0cafb6 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py index 278b83aaa..6c6a35b7e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_base.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py index 60acd170d..35e391517 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_checkbox.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py index 8d71ca65a..09a85e20f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_custom_field_text.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group.py b/sdks/python/dropbox_sign/models/template_response_document_field_group.py index b9774c263..8f3bc1a16 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py index df4e5b827..17d81cbd9 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py +++ b/sdks/python/dropbox_sign/models/template_response_document_field_group_rule.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py index ff2269fa8..6f8777a3b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_base.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py index a24921b12..d81d6572a 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_checkbox.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py index 8b7f3d13f..8ee5fe31b 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_date_signed.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py index 76b035657..2b30ae4c5 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_dropdown.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py index 9e9798369..0102248d3 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_hyperlink.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py index 1f4eb7392..64321add8 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_initials.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py index f0855859c..0f0c3443a 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_radio.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py index 844558f21..c509f92ce 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_signature.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py index 3fcd28712..6280970f4 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_form_field_text.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py index 927c2c026..d9735c703 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_base.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py index d8d1f135f..0afba0d9f 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_checkbox.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py index bfc9f2e33..0b232a6c9 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_date_signed.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py index fb7cde0fb..7ac71ec4e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_dropdown.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py index dd322e0e6..bdd27c9d2 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_hyperlink.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py index 22da86102..bd755ee8e 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_initials.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py index cb58af258..a78d5b803 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_radio.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py index 664b3d7d2..c0ff8eee6 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_signature.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py index a70afa340..03a3a4831 100644 --- a/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py +++ b/sdks/python/dropbox_sign/models/template_response_document_static_field_text.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py index 34dc71172..1936e75ee 100644 --- a/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py +++ b/sdks/python/dropbox_sign/models/template_response_field_avg_text_length.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_response_signer_role.py b/sdks/python/dropbox_sign/models/template_response_signer_role.py index 571469e90..2cada158d 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_update_files_request.py b/sdks/python/dropbox_sign/models/template_update_files_request.py index 424a254b0..18612ddbf 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_request.py +++ b/sdks/python/dropbox_sign/models/template_update_files_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response.py b/sdks/python/dropbox_sign/models/template_update_files_response.py index 94b562027..67b1d3b68 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/template_update_files_response_template.py b/sdks/python/dropbox_sign/models/template_update_files_response_template.py index 0825101cb..2a8cd11ad 100644 --- a/sdks/python/dropbox_sign/models/template_update_files_response_template.py +++ b/sdks/python/dropbox_sign/models/template_update_files_response_template.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py index 2ca5e9c5b..26e98fb43 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -175,6 +176,10 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): default=False, description="Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) populate_auto_fill_fields: Optional[StrictBool] = Field( default=False, description="Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.", @@ -218,6 +223,7 @@ class UnclaimedDraftCreateEmbeddedRequest(BaseModel): "type", "use_preexisting_fields", "use_text_tags", + "ignore_text_tags_extraction_errors", "populate_auto_fill_fields", "expires_at", ] @@ -482,6 +488,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_text_tags") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), "populate_auto_fill_fields": ( obj.get("populate_auto_fill_fields") if obj.get("populate_auto_fill_fields") is not None @@ -539,6 +550,7 @@ def openapi_types(cls) -> Dict[str, str]: "type": "(str,)", "use_preexisting_fields": "(bool,)", "use_text_tags": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", "populate_auto_fill_fields": "(bool,)", "expires_at": "(int,)", } diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py index 7ce070ff1..3ab702393 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_embedded_with_template_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py index 88ae6835e..deacb02c8 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 @@ -134,6 +135,10 @@ class UnclaimedDraftCreateRequest(BaseModel): default=False, description="Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.", ) + ignore_text_tags_extraction_errors: Optional[StrictBool] = Field( + default=False, + description="Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`.", + ) expires_at: Optional[StrictInt] = Field( default=None, description="When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response.", @@ -162,6 +167,7 @@ class UnclaimedDraftCreateRequest(BaseModel): "test_mode", "use_preexisting_fields", "use_text_tags", + "ignore_text_tags_extraction_errors", "expires_at", ] @@ -374,6 +380,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("use_text_tags") is not None else False ), + "ignore_text_tags_extraction_errors": ( + obj.get("ignore_text_tags_extraction_errors") + if obj.get("ignore_text_tags_extraction_errors") is not None + else False + ), "expires_at": obj.get("expires_at"), } ) @@ -415,6 +426,7 @@ def openapi_types(cls) -> Dict[str, str]: "test_mode": "(bool,)", "use_preexisting_fields": "(bool,)", "use_text_tags": "(bool,)", + "ignore_text_tags_extraction_errors": "(bool,)", "expires_at": "(int,)", } diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py index dab0513a1..085e5b907 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_create_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py index 29e4afe3a..38903beef 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_edit_and_resend_request.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py index 5f8849d69..51fdcfa9b 100644 --- a/sdks/python/dropbox_sign/models/unclaimed_draft_response.py +++ b/sdks/python/dropbox_sign/models/unclaimed_draft_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/models/warning_response.py b/sdks/python/dropbox_sign/models/warning_response.py index 5e0b464ce..d2a26d5c3 100644 --- a/sdks/python/dropbox_sign/models/warning_response.py +++ b/sdks/python/dropbox_sign/models/warning_response.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + from __future__ import annotations import pprint import re # noqa: F401 diff --git a/sdks/python/dropbox_sign/rest.py b/sdks/python/dropbox_sign/rest.py index dcabe9c34..4aaa80dbe 100644 --- a/sdks/python/dropbox_sign/rest.py +++ b/sdks/python/dropbox_sign/rest.py @@ -12,6 +12,7 @@ Do not edit the class manually. """ # noqa: E501 + import io import json import re diff --git a/sdks/python/templates/test-requirements.mustache b/sdks/python/templates/test-requirements.mustache index 9453a41d9..e8273336c 100644 --- a/sdks/python/templates/test-requirements.mustache +++ b/sdks/python/templates/test-requirements.mustache @@ -5,5 +5,5 @@ flake8 >= 4.0.0 types-python-dateutil >= 2.8.19.14 mypy >= 1.5 {{#useCustomTemplateCode}} -black>=24.8.0 +black==25.1.0 {{/useCustomTemplateCode}} diff --git a/sdks/python/test-requirements.txt b/sdks/python/test-requirements.txt index 66589730f..29d3726e6 100644 --- a/sdks/python/test-requirements.txt +++ b/sdks/python/test-requirements.txt @@ -4,4 +4,4 @@ tox >= 3.9.0 flake8 >= 4.0.0 types-python-dateutil >= 2.8.19.14 mypy >= 1.5 -black>=24.8.0 +black==25.1.0 diff --git a/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md index 72ba0eed1..c28a2b4b8 100644 --- a/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestCreateEmbeddedRequest.md @@ -28,6 +28,7 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md index 383cd8e89..6a56a2eb0 100644 --- a/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditEmbeddedRequest.md @@ -28,6 +28,7 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/ruby/docs/SignatureRequestEditRequest.md b/sdks/ruby/docs/SignatureRequestEditRequest.md index ce5325052..b7e4ffb6a 100644 --- a/sdks/ruby/docs/SignatureRequestEditRequest.md +++ b/sdks/ruby/docs/SignatureRequestEditRequest.md @@ -30,5 +30,6 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/ruby/docs/SignatureRequestSendRequest.md b/sdks/ruby/docs/SignatureRequestSendRequest.md index ca6f16746..51bb1a2d1 100644 --- a/sdks/ruby/docs/SignatureRequestSendRequest.md +++ b/sdks/ruby/docs/SignatureRequestSendRequest.md @@ -31,5 +31,6 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | | diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md index d23e4cea8..4cbd9bf00 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftRequest.md @@ -31,4 +31,5 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/TemplateCreateRequest.md b/sdks/ruby/docs/TemplateCreateRequest.md index 35e9df09e..1d543e1a4 100644 --- a/sdks/ruby/docs/TemplateCreateRequest.md +++ b/sdks/ruby/docs/TemplateCreateRequest.md @@ -24,4 +24,5 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `title` | ```String``` | The title you want to assign to the SignatureRequest. | | | `use_preexisting_fields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md index 47acc3977..1023778f6 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateEmbeddedRequest.md @@ -40,6 +40,7 @@ | `type` | ```String``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to 'request_signature'] | | `use_preexisting_fields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `use_text_tags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.

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

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md index 3eeacd59f..75eab21d7 100644 --- a/sdks/ruby/docs/UnclaimedDraftCreateRequest.md +++ b/sdks/ruby/docs/UnclaimedDraftCreateRequest.md @@ -29,5 +29,6 @@ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] | | `use_preexisting_fields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | | `use_text_tags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] | +| `ignore_text_tags_extraction_errors` | ```Boolean``` | Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. | [default to false] | | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

**NOTE:** This does not correspond to the **expires_at** returned in the response. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb index 9ea538769..d6f857ba4 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_create_embedded_request.rb @@ -104,6 +104,10 @@ class SignatureRequestCreateEmbeddedRequest # @return [Boolean] attr_accessor :use_text_tags + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. # @return [Boolean] attr_accessor :populate_auto_fill_fields @@ -137,6 +141,7 @@ def self.attribute_map :'test_mode' => :'test_mode', :'title' => :'title', :'use_text_tags' => :'use_text_tags', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors', :'populate_auto_fill_fields' => :'populate_auto_fill_fields', :'expires_at' => :'expires_at' } @@ -177,6 +182,7 @@ def self.openapi_types :'test_mode' => :'Boolean', :'title' => :'String', :'use_text_tags' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean', :'populate_auto_fill_fields' => :'Boolean', :'expires_at' => :'Integer' } @@ -350,6 +356,12 @@ def initialize(attributes = {}) self.use_text_tags = false end + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end + if attributes.key?(:'populate_auto_fill_fields') self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] else @@ -467,6 +479,7 @@ def ==(o) test_mode == o.test_mode && title == o.title && use_text_tags == o.use_text_tags && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors && populate_auto_fill_fields == o.populate_auto_fill_fields && expires_at == o.expires_at end @@ -480,7 +493,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, ignore_text_tags_extraction_errors, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb index eb9ece9ee..7fc162d16 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb @@ -104,6 +104,10 @@ class SignatureRequestEditEmbeddedRequest # @return [Boolean] attr_accessor :use_text_tags + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. # @return [Boolean] attr_accessor :populate_auto_fill_fields @@ -137,6 +141,7 @@ def self.attribute_map :'test_mode' => :'test_mode', :'title' => :'title', :'use_text_tags' => :'use_text_tags', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors', :'populate_auto_fill_fields' => :'populate_auto_fill_fields', :'expires_at' => :'expires_at' } @@ -177,6 +182,7 @@ def self.openapi_types :'test_mode' => :'Boolean', :'title' => :'String', :'use_text_tags' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean', :'populate_auto_fill_fields' => :'Boolean', :'expires_at' => :'Integer' } @@ -350,6 +356,12 @@ def initialize(attributes = {}) self.use_text_tags = false end + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end + if attributes.key?(:'populate_auto_fill_fields') self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] else @@ -467,6 +479,7 @@ def ==(o) test_mode == o.test_mode && title == o.title && use_text_tags == o.use_text_tags && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors && populate_auto_fill_fields == o.populate_auto_fill_fields && expires_at == o.expires_at end @@ -480,7 +493,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, signing_options, subject, test_mode, title, use_text_tags, ignore_text_tags_extraction_errors, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb index 68e7c2f6c..43d7f12bf 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_edit_request.rb @@ -112,6 +112,10 @@ class SignatureRequestEditRequest # @return [Boolean] attr_accessor :use_text_tags + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. # @return [Integer, nil] attr_accessor :expires_at @@ -143,6 +147,7 @@ def self.attribute_map :'test_mode' => :'test_mode', :'title' => :'title', :'use_text_tags' => :'use_text_tags', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors', :'expires_at' => :'expires_at' } end @@ -184,6 +189,7 @@ def self.openapi_types :'test_mode' => :'Boolean', :'title' => :'String', :'use_text_tags' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean', :'expires_at' => :'Integer' } end @@ -366,6 +372,12 @@ def initialize(attributes = {}) self.use_text_tags = false end + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end + if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end @@ -464,6 +476,7 @@ def ==(o) test_mode == o.test_mode && title == o.title && use_text_tags == o.use_text_tags && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors && expires_at == o.expires_at end @@ -476,7 +489,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, ignore_text_tags_extraction_errors, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb index 8dec7e411..dd3ad81d6 100644 --- a/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/signature_request_send_request.rb @@ -116,6 +116,10 @@ class SignatureRequestSendRequest # @return [Boolean] attr_accessor :use_text_tags + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. # @return [Integer, nil] attr_accessor :expires_at @@ -148,6 +152,7 @@ def self.attribute_map :'test_mode' => :'test_mode', :'title' => :'title', :'use_text_tags' => :'use_text_tags', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors', :'expires_at' => :'expires_at' } end @@ -190,6 +195,7 @@ def self.openapi_types :'test_mode' => :'Boolean', :'title' => :'String', :'use_text_tags' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean', :'expires_at' => :'Integer' } end @@ -378,6 +384,12 @@ def initialize(attributes = {}) self.use_text_tags = false end + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end + if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end @@ -477,6 +489,7 @@ def ==(o) test_mode == o.test_mode && title == o.title && use_text_tags == o.use_text_tags && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors && expires_at == o.expires_at end @@ -489,7 +502,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, expires_at].hash + [files, file_urls, signers, grouped_signers, allow_decline, allow_reassign, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, is_qualified_signature, is_eid, message, metadata, signing_options, signing_redirect_url, subject, test_mode, title, use_text_tags, ignore_text_tags_extraction_errors, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb index 4b006bdac..a846072e1 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_request.rb @@ -116,6 +116,10 @@ class TemplateCreateEmbeddedDraftRequest # @return [Boolean] attr_accessor :use_preexisting_fields + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -143,7 +147,8 @@ def self.attribute_map :'subject' => :'subject', :'test_mode' => :'test_mode', :'title' => :'title', - :'use_preexisting_fields' => :'use_preexisting_fields' + :'use_preexisting_fields' => :'use_preexisting_fields', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors' } end @@ -184,7 +189,8 @@ def self.openapi_types :'subject' => :'String', :'test_mode' => :'Boolean', :'title' => :'String', - :'use_preexisting_fields' => :'Boolean' + :'use_preexisting_fields' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean' } end @@ -372,6 +378,12 @@ def initialize(attributes = {}) else self.use_preexisting_fields = false end + + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -467,7 +479,8 @@ def ==(o) subject == o.subject && test_mode == o.test_mode && title == o.title && - use_preexisting_fields == o.use_preexisting_fields + use_preexisting_fields == o.use_preexisting_fields && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors end # @see the `==` method @@ -479,7 +492,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, files, file_urls, allow_ccs, allow_reassign, attachments, cc_roles, editor_options, field_options, force_signer_roles, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, merge_fields, message, metadata, show_preview, show_progress_stepper, signer_roles, skip_me_now, subject, test_mode, title, use_preexisting_fields].hash + [client_id, files, file_urls, allow_ccs, allow_reassign, attachments, cc_roles, editor_options, field_options, force_signer_roles, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, merge_fields, message, metadata, show_preview, show_progress_stepper, signer_roles, skip_me_now, subject, test_mode, title, use_preexisting_fields, ignore_text_tags_extraction_errors].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb index 2376b7867..8b3d47022 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_request.rb @@ -89,6 +89,10 @@ class TemplateCreateRequest # @return [Boolean] attr_accessor :use_preexisting_fields + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -109,7 +113,8 @@ def self.attribute_map :'subject' => :'subject', :'test_mode' => :'test_mode', :'title' => :'title', - :'use_preexisting_fields' => :'use_preexisting_fields' + :'use_preexisting_fields' => :'use_preexisting_fields', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors' } end @@ -143,7 +148,8 @@ def self.openapi_types :'subject' => :'String', :'test_mode' => :'Boolean', :'title' => :'String', - :'use_preexisting_fields' => :'Boolean' + :'use_preexisting_fields' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean' } end @@ -291,6 +297,12 @@ def initialize(attributes = {}) else self.use_preexisting_fields = false end + + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -394,7 +406,8 @@ def ==(o) subject == o.subject && test_mode == o.test_mode && title == o.title && - use_preexisting_fields == o.use_preexisting_fields + use_preexisting_fields == o.use_preexisting_fields && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors end # @see the `==` method @@ -406,7 +419,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [form_fields_per_document, signer_roles, files, file_urls, allow_reassign, attachments, cc_roles, client_id, field_options, form_field_groups, form_field_rules, merge_fields, message, metadata, subject, test_mode, title, use_preexisting_fields].hash + [form_fields_per_document, signer_roles, files, file_urls, allow_reassign, attachments, cc_roles, client_id, field_options, form_field_groups, form_field_rules, merge_fields, message, metadata, subject, test_mode, title, use_preexisting_fields, ignore_text_tags_extraction_errors].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb index 210aae825..9d52d17fc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb @@ -152,6 +152,10 @@ class UnclaimedDraftCreateEmbeddedRequest # @return [Boolean] attr_accessor :use_text_tags + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. # @return [Boolean] attr_accessor :populate_auto_fill_fields @@ -219,6 +223,7 @@ def self.attribute_map :'type' => :'type', :'use_preexisting_fields' => :'use_preexisting_fields', :'use_text_tags' => :'use_text_tags', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors', :'populate_auto_fill_fields' => :'populate_auto_fill_fields', :'expires_at' => :'expires_at' } @@ -271,6 +276,7 @@ def self.openapi_types :'type' => :'String', :'use_preexisting_fields' => :'Boolean', :'use_text_tags' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean', :'populate_auto_fill_fields' => :'Boolean', :'expires_at' => :'Integer' } @@ -508,6 +514,12 @@ def initialize(attributes = {}) self.use_text_tags = false end + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end + if attributes.key?(:'populate_auto_fill_fields') self.populate_auto_fill_fields = attributes[:'populate_auto_fill_fields'] else @@ -649,6 +661,7 @@ def ==(o) type == o.type && use_preexisting_fields == o.use_preexisting_fields && use_text_tags == o.use_text_tags && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors && populate_auto_fill_fields == o.populate_auto_fill_fields && expires_at == o.expires_at end @@ -662,7 +675,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, populate_auto_fill_fields, expires_at].hash + [client_id, requester_email_address, files, file_urls, allow_ccs, allow_decline, allow_reassign, attachments, cc_email_addresses, custom_fields, editor_options, field_options, force_signer_page, force_subject_message, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, hold_request, is_for_embedded_signing, message, metadata, requesting_redirect_url, show_preview, show_progress_stepper, signers, signing_options, signing_redirect_url, skip_me_now, subject, test_mode, type, use_preexisting_fields, use_text_tags, ignore_text_tags_extraction_errors, populate_auto_fill_fields, expires_at].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb index 3aa84129f..62c54fcbc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/unclaimed_draft_create_request.rb @@ -109,6 +109,10 @@ class UnclaimedDraftCreateRequest # @return [Boolean] attr_accessor :use_text_tags + # Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. + # @return [Boolean] + attr_accessor :ignore_text_tags_extraction_errors + # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **NOTE:** This does not correspond to the **expires_at** returned in the response. # @return [Integer, nil] attr_accessor :expires_at @@ -161,6 +165,7 @@ def self.attribute_map :'test_mode' => :'test_mode', :'use_preexisting_fields' => :'use_preexisting_fields', :'use_text_tags' => :'use_text_tags', + :'ignore_text_tags_extraction_errors' => :'ignore_text_tags_extraction_errors', :'expires_at' => :'expires_at' } end @@ -201,6 +206,7 @@ def self.openapi_types :'test_mode' => :'Boolean', :'use_preexisting_fields' => :'Boolean', :'use_text_tags' => :'Boolean', + :'ignore_text_tags_extraction_errors' => :'Boolean', :'expires_at' => :'Integer' } end @@ -377,6 +383,12 @@ def initialize(attributes = {}) self.use_text_tags = false end + if attributes.key?(:'ignore_text_tags_extraction_errors') + self.ignore_text_tags_extraction_errors = attributes[:'ignore_text_tags_extraction_errors'] + else + self.ignore_text_tags_extraction_errors = false + end + if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end @@ -476,6 +488,7 @@ def ==(o) test_mode == o.test_mode && use_preexisting_fields == o.use_preexisting_fields && use_text_tags == o.use_text_tags && + ignore_text_tags_extraction_errors == o.ignore_text_tags_extraction_errors && expires_at == o.expires_at end @@ -488,7 +501,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, files, file_urls, allow_decline, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, show_progress_stepper, signers, signing_options, signing_redirect_url, subject, test_mode, use_preexisting_fields, use_text_tags, expires_at].hash + [type, files, file_urls, allow_decline, attachments, cc_email_addresses, client_id, custom_fields, field_options, form_field_groups, form_field_rules, form_fields_per_document, hide_text_tags, message, metadata, show_progress_stepper, signers, signing_options, signing_redirect_url, subject, test_mode, use_preexisting_fields, use_text_tags, ignore_text_tags_extraction_errors, expires_at].hash end # Builds the object from hash diff --git a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json index 097446a77..3b62c461c 100644 --- a/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ b/test_fixtures/SignatureRequestCreateEmbeddedRequest.json @@ -122,7 +122,8 @@ "subject": "The NDA we talked about", "test_mode": true, "title": "NDA with Acme Co.", - "use_text_tags": false + "use_text_tags": false, + "ignore_text_tags_extraction_errors": false }, "with_grouped_signers": { "allow_decline": true, @@ -259,6 +260,7 @@ "subject": "The NDA we talked about", "test_mode": true, "title": "NDA with Acme Co.", - "use_text_tags": false + "use_text_tags": false, + "ignore_text_tags_extraction_errors": false } } diff --git a/test_fixtures/SignatureRequestSendRequest.json b/test_fixtures/SignatureRequestSendRequest.json index 1f56eb7cc..d5e59f7cb 100644 --- a/test_fixtures/SignatureRequestSendRequest.json +++ b/test_fixtures/SignatureRequestSendRequest.json @@ -236,7 +236,8 @@ "subject": "The NDA we talked about", "test_mode": true, "title": "NDA with Acme Co.", - "use_text_tags": true + "use_text_tags": true, + "ignore_text_tags_extraction_errors": false }, "with_grouped_signers": { "allow_decline": true, @@ -476,6 +477,7 @@ "subject": "The NDA we talked about", "test_mode": true, "title": "NDA with Acme Co.", - "use_text_tags": true + "use_text_tags": true, + "ignore_text_tags_extraction_errors": false } } diff --git a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json index b293945e7..96919f9ac 100644 --- a/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +++ b/test_fixtures/TemplateCreateEmbeddedDraftRequest.json @@ -120,6 +120,7 @@ "subject": "Please sign this document", "test_mode": true, "title": "Test Template", - "use_preexisting_fields": true + "use_preexisting_fields": true, + "ignore_text_tags_extraction_errors": false } } diff --git a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json index addbe6ac5..4cdf5e14c 100644 --- a/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +++ b/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json @@ -137,6 +137,7 @@ "test_mode": true, "type": "send_document", "use_preexisting_fields": true, - "use_text_tags": true + "use_text_tags": true, + "ignore_text_tags_extraction_errors": false } } diff --git a/test_fixtures/UnclaimedDraftCreateRequest.json b/test_fixtures/UnclaimedDraftCreateRequest.json index a9ab5b5f4..008df320e 100644 --- a/test_fixtures/UnclaimedDraftCreateRequest.json +++ b/test_fixtures/UnclaimedDraftCreateRequest.json @@ -122,6 +122,7 @@ "test_mode": true, "type": "send_document", "use_preexisting_fields": true, - "use_text_tags": true + "use_text_tags": true, + "ignore_text_tags_extraction_errors": false } } diff --git a/translations/en.yaml b/translations/en.yaml index f32507e4f..dbe46e309 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -362,6 +362,7 @@ "SignatureRequestCreateEmbedded::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. "SignatureRequestCreateEmbedded::TITLE": The title you want to assign to the SignatureRequest. "SignatureRequestCreateEmbedded::USE_TEXT_TAGS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. +"SignatureRequestCreateEmbedded::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS": Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. "SignatureRequestCreateEmbedded::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "SignatureRequestCreateEmbedded::SIGNER_EXPERIENCE": Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. @@ -501,6 +502,7 @@ "SignatureRequestSend::TITLE": The title you want to assign to the SignatureRequest. "SignatureRequestSend::EXPIRES_AT": When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. "SignatureRequestSend::USE_PREEXISTING_FIELDS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. +"SignatureRequestSend::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS": Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. "SignatureRequestSend::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "SignatureRequestSend::SIGNER_EXPERIENCE": Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. @@ -705,6 +707,7 @@ "TemplateCreateEmbeddedDraft::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. "TemplateCreateEmbeddedDraft::TITLE": The title you want to assign to the SignatureRequest. "TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). +"TemplateCreateEmbeddedDraft::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS": Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. "TemplateCreateEmbeddedDraft::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "TemplateCreateEmbeddedDraft::SIGNER_EXPERIENCE": Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. @@ -740,6 +743,7 @@ "TemplateCreate::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. "TemplateCreate::TITLE": The title you want to assign to the SignatureRequest. "TemplateCreate::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). +"TemplateCreate::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS": Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. "TemplateCreate::ALLOW_FORM_VIEW": Allows signers to view the form fields before signing if set to `true`. Defaults to `false`. "TemplateCreate::SIGNER_EXPERIENCE": Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. @@ -849,6 +853,7 @@ "UnclaimedDraftCreate::TYPE": The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. "UnclaimedDraftCreate::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. "UnclaimedDraftCreate::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. +"UnclaimedDraftCreate::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS": Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. "UnclaimedDraftCreate::SIGNER_EXPERIENCE": Configuration options for modifying the settings of the signer application. Supports changing the form view behavior. "UnclaimedDraftCreate::EXPIRES_AT": |- When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. @@ -898,6 +903,7 @@ "UnclaimedDraftCreateEmbedded::TYPE": The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. "UnclaimedDraftCreateEmbedded::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. "UnclaimedDraftCreateEmbedded::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. +"UnclaimedDraftCreateEmbedded::IGNORE_TEXT_TAGS_EXTRACTION_ERRORS": Sent with a value of `true` to ignore the validation errors from text tags extraction. Defaults to `false`. "UnclaimedDraftCreateEmbedded::POPULATE_AUTO_FILL_FIELDS": |- Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. From fbacb65b1bf7c2f8a1c1c8837ce5d52717dfb1a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrzej=20Dani=C5=82owski?= Date: Wed, 13 May 2026 09:36:18 +0200 Subject: [PATCH 2/6] [SIGN-15354] Improve releasing SDKs (#545) --- README.md | 34 ++++++++++++++ copy-sdks | 136 ++++++++++++++++++++++++++++++++++++++++++++++------- reset-sdks | 40 ++++++++++++++++ 3 files changed, 192 insertions(+), 18 deletions(-) create mode 100755 reset-sdks diff --git a/README.md b/README.md index f55872138..b31036e6a 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,40 @@ To rebuild all SDKs run `./generate-sdks -t all`. Changes will appear against the [/sdks](sdks) directory. Make sure to include these changes in your pull requests! +### Releasing SDKs + +The [copy-sdks](copy-sdks) script copies built SDK files from [/sdks](sdks) into the [/repos](repos) directory, updates version numbers, commits, and pushes a release branch. + +You can release a single SDK with an explicit version: + +```bash +./copy-sdks -t php -v 1.4.0 +``` + +Or release multiple SDKs at once, with automatic version bumps (reads the current version from `repos/[SDK]/VERSION`): + +```bash +./copy-sdks -t python,node,ruby # specific SDKs, auto-bump minor +./copy-sdks -t all # all SDKs, auto-bump minor +./copy-sdks -t all -b patch # all SDKs, auto-bump patch +./copy-sdks -t all -b major # all SDKs, auto-bump major +./copy-sdks -t all -v 2.0.0 # all SDKs, explicit version +``` + +The `-b` flag accepts `major`, `minor` (default), or `patch`. + +The script shows a summary table of current and new versions and asks for confirmation before proceeding. + +### Resetting SDK Repos + +The [reset-sdks](reset-sdks) script resets SDK repos in [/repos](repos) back to their main branch (pulling latest from origin). Useful before starting a new release cycle. + +```bash +./reset-sdks # reset all SDK repos +./reset-sdks ruby # reset a single SDK +./reset-sdks python,node,ruby # reset specific SDKs +``` + ### Changes to Generated SDK Code We generate our SDKs using the [OpenAPI Generator](https://openapi-generator.tech/) tool. This tool reads the contents of the [openapi-sdk.yaml](openapi-sdk.yaml) file. It also reads related examples from the [/examples](examples) directory and embeds the contents into the generated documentation. diff --git a/copy-sdks b/copy-sdks index 2fffe8b51..34f1186cd 100755 --- a/copy-sdks +++ b/copy-sdks @@ -7,6 +7,7 @@ SDKS=( dotnet java-v1 java-v2 node php python ruby ) SHOW_HELP=0 TARGET_SDK= TARGET_VERSION= +BUMP_TYPE=minor REPO_DOTNET="https://github.com/hellosign/dropbox-sign-dotnet.git" REPO_JAVA_V1="--branch v1 https://github.com/hellosign/dropbox-sign-java.git" @@ -18,12 +19,14 @@ REPO_RUBY="https://github.com/hellosign/dropbox-sign-ruby.git" REPO_MAIN_BRANCH="main" -while getopts ":t:v:h" opt; do +while getopts ":t:v:b:h" opt; do case $opt in t) TARGET_SDK="$OPTARG" ;; v) TARGET_VERSION="$OPTARG" ;; + b) BUMP_TYPE="$OPTARG" + ;; h) SHOW_HELP=1 ;; \?) echo "Invalid option -$OPTARG" >&2 @@ -31,17 +34,103 @@ while getopts ":t:v:h" opt; do esac done +function get_current_version() +{ + local sdk="$1" + local version_file="${DIR}/repos/${sdk}/VERSION" + + if [[ ! -f "${version_file}" ]]; then + printf "ERROR: VERSION file not found at %s\n" "${version_file}" >&2 + exit 1 + fi + + grep -oE '[0-9]+\.[0-9]+\.[0-9]+' "${version_file}" | head -1 +} + +function bump_version() +{ + local current="$1" + local type="$2" + local major minor patch + major=$(echo "$current" | cut -d. -f1) + minor=$(echo "$current" | cut -d. -f2) + patch=$(echo "$current" | cut -d. -f3) + + case "$type" in + major) echo "$((major + 1)).0.0" ;; + minor) echo "${major}.$((minor + 1)).0" ;; + patch) echo "${major}.${minor}.$((patch + 1))" ;; + *) + printf "Invalid bump type: %s (must be major, minor, or patch)\n" "$type" >&2 + exit 1 + ;; + esac +} + function main() { - if [[ -z ${TARGET_SDK} || -z ${TARGET_VERSION} ]]; then + if [[ -z ${TARGET_SDK} ]]; then show_help + exit 0 + fi + + # Parse target SDKs: "all", comma-separated, or single + local sdk_list=() + if [[ "${TARGET_SDK}" == "all" ]]; then + sdk_list=("${SDKS[@]}") + else + IFS=',' read -ra sdk_list <<< "${TARGET_SDK}" + fi + for sdk in "${sdk_list[@]}"; do + validate_sdk_choice "$sdk" + done + + # Resolve versions and build summary + local versions=() + local current_versions=() + for sdk in "${sdk_list[@]}"; do + local current_ver + current_ver=$(get_current_version "$sdk") + current_versions+=("$current_ver") + + if [[ -n "${TARGET_VERSION}" ]]; then + versions+=("${TARGET_VERSION}") + else + versions+=("$(bump_version "$current_ver" "$BUMP_TYPE")") + fi + done + + # Show summary table + printf "\n%-12s %-15s %-15s\n" "SDK" "Current" "New Version" + printf "%-12s %-15s %-15s\n" "---" "-------" "-----------" + for i in "${!sdk_list[@]}"; do + printf "%-12s %-15s %-15s\n" "${sdk_list[$i]}" "${current_versions[$i]}" "${versions[$i]}" + done + printf "\n" + + read -p "Proceed? [y/N] " confirm + if [[ "${confirm}" != "y" && "${confirm}" != "Y" ]]; then + printf "Aborted.\n" exit 0 fi - validate_sdk_choice $TARGET_SDK - copy_files $TARGET_SDK $TARGET_VERSION + # Process each SDK + for i in "${!sdk_list[@]}"; do + local sdk="${sdk_list[$i]}" + local ver="${versions[$i]}" + + printf "\n=== Processing %s %s ===\n" "$sdk" "$ver" + + REPO_MAIN_BRANCH="main" + if [[ "${sdk}" == "java-v1" ]]; then + REPO_MAIN_BRANCH="v1" + fi - printf "Success! Ready for git commit!\n" + copy_files "$sdk" "$ver" + printf "Done: %s %s\n" "$sdk" "$ver" + done + + printf "\nSuccess! All SDKs committed and pushed.\n" exit 0 } @@ -53,10 +142,19 @@ Copies build files for a given SDK into the repos/[SDK] directory. **WARNING** All files and directories present in the repos/[SDK] directory will be DELETED, except for the .git directory! --t target SDK, "dotnet", "java-v2", "java-v1", "node", "php", "python", "ruby" +-t target SDK(s): a single SDK, comma-separated list, or "all" + valid: dotnet, java-v1, java-v2, node, php, python, ruby, all -v version of the SDK, ex: 1.4.0 + if omitted, auto-bumps version from repos/[SDK]/VERSION +-b bump type when -v is omitted: major, minor (default), or patch -h display this help and exit -Example: copy-sdks -t php -v 1.4.0 + +Examples: + copy-sdks -t php -v 1.4.0 # single SDK, explicit version + copy-sdks -t python,node,ruby # multiple SDKs, auto-bump minor + copy-sdks -t all # all SDKs, auto-bump minor + copy-sdks -t all -b patch # all SDKs, auto-bump patch + copy-sdks -t all -v 2.0.0 # all SDKs, same explicit version EOF exit 0 @@ -80,10 +178,6 @@ function validate_sdk_choice() exit 1 fi - - if [[ "${SDK}" == "java-v1" ]]; then - REPO_MAIN_BRANCH="v1" - fi } function copy_files() @@ -101,7 +195,7 @@ function copy_files() git reset --hard origin/${REPO_MAIN_BRANCH} git pull origin ${REPO_MAIN_BRANCH} - git checkout -b "release-${VERSION}" + git checkout "release-${VERSION}" 2>/dev/null || git checkout -b "release-${VERSION}" git rm -rf --cached . popd @@ -121,22 +215,28 @@ function copy_files() cp -r "${DIR}/openapi-sdk.yaml" "${SDK_DIR}/openapi-sdk.yaml" + local EXAMPLES_SRC="${DIR}/sdks/${SDK}/examples" + if [[ "${SDK}" == "dotnet" ]]; then - "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" cs + "${DIR}/bin/copy-examples-filtered" "${EXAMPLES_SRC}" "${SDK_DIR}/examples" cs elif [[ "${SDK}" == "java-v2" ]] || [[ "${SDK}" == "java-v1" ]]; then - "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" java + "${DIR}/bin/copy-examples-filtered" "${EXAMPLES_SRC}" "${SDK_DIR}/examples" java elif [[ "${SDK}" == "node" ]]; then - "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" ts + "${DIR}/bin/copy-examples-filtered" "${EXAMPLES_SRC}" "${SDK_DIR}/examples" ts elif [[ "${SDK}" == "php" ]]; then - "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" php + "${DIR}/bin/copy-examples-filtered" "${EXAMPLES_SRC}" "${SDK_DIR}/examples" php elif [[ "${SDK}" == "python" ]]; then - "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" py + "${DIR}/bin/copy-examples-filtered" "${EXAMPLES_SRC}" "${SDK_DIR}/examples" py elif [[ "${SDK}" == "ruby" ]]; then - "${DIR}/bin/copy-examples-filtered" "${DIR}/examples" "${SDK_DIR}/examples" rb + "${DIR}/bin/copy-examples-filtered" "${EXAMPLES_SRC}" "${SDK_DIR}/examples" rb fi php "${DIR}/bin/update-sdk-version.php" ${SDK} ${VERSION} + git add -A + git commit -m "Release ${VERSION}" + git push -u origin "release-${VERSION}" + popd } diff --git a/reset-sdks b/reset-sdks new file mode 100755 index 000000000..5a837ca74 --- /dev/null +++ b/reset-sdks @@ -0,0 +1,40 @@ +#!/usr/bin/env bash + +set -e + +DIR=$(cd `dirname $0` && pwd) +ALL_SDKS=( dotnet java-v1 java-v2 node php python ruby ) +TARGET="${1:-all}" + +if [[ "${TARGET}" == "all" ]]; then + SDKS=("${ALL_SDKS[@]}") +else + IFS=',' read -ra SDKS <<< "${TARGET}" +fi + +for SDK in "${SDKS[@]}"; do + SDK_DIR="${DIR}/repos/${SDK}" + BRANCH="main" + + if [[ "${SDK}" == "java-v1" ]]; then + BRANCH="v1" + fi + + if [[ ! -d "${SDK_DIR}/.git" ]]; then + printf "SKIP: %s (not cloned at %s)\n" "$SDK" "$SDK_DIR" + continue + fi + + printf "Resetting %s to %s...\n" "$SDK" "$BRANCH" + pushd "${SDK_DIR}/" > /dev/null + + git checkout "$BRANCH" + git reset --hard "origin/${BRANCH}" + git pull origin "$BRANCH" + git fetch --prune + + popd > /dev/null + printf "Done: %s\n\n" "$SDK" +done + +printf "All SDK repos reset.\n" From f20270caca1422e8cbc25999b9df9703bef74a6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrzej=20Dani=C5=82owski?= Date: Wed, 13 May 2026 11:01:03 +0200 Subject: [PATCH 3/6] Update dev versions (#546) --- README.md | 10 ++++ sdks/dotnet/README.md | 2 +- sdks/dotnet/VERSION | 2 +- sdks/dotnet/openapi-config.yaml | 2 +- .../src/Dropbox.Sign/Client/Configuration.cs | 6 +-- .../src/Dropbox.Sign/Dropbox.Sign.csproj | 2 +- sdks/java-v1/README.md | 8 +-- sdks/java-v1/VERSION | 2 +- sdks/java-v1/build.gradle | 2 +- sdks/java-v1/build.sbt | 2 +- sdks/java-v1/gradle.properties | 2 +- sdks/java-v1/openapi-config.yaml | 2 +- sdks/java-v1/pom.xml | 2 +- .../main/java/com/dropbox/sign/ApiClient.java | 2 +- .../java/com/dropbox/sign/Configuration.java | 2 +- sdks/java-v2/README.md | 8 +-- sdks/java-v2/VERSION | 2 +- sdks/java-v2/build.gradle | 2 +- sdks/java-v2/build.sbt | 2 +- sdks/java-v2/gradle.properties | 2 +- sdks/java-v2/openapi-config.yaml | 2 +- sdks/java-v2/pom.xml | 2 +- .../main/java/com/dropbox/sign/ApiClient.java | 2 +- .../java/com/dropbox/sign/Configuration.java | 2 +- sdks/node/VERSION | 2 +- sdks/node/api/apis.ts | 2 +- sdks/node/dist/api.js | 2 +- sdks/node/openapi-config.yaml | 2 +- sdks/node/package-lock.json | 4 +- sdks/node/package.json | 2 +- sdks/node/types/api/apis.d.ts | 2 +- sdks/php/README.md | 6 +-- sdks/php/VERSION | 2 +- sdks/php/openapi-config.yaml | 4 +- sdks/php/src/Configuration.php | 4 +- sdks/python/README.md | 4 +- sdks/python/VERSION | 2 +- sdks/python/dropbox_sign/__init__.py | 2 +- sdks/python/dropbox_sign/api_client.py | 2 +- sdks/python/dropbox_sign/configuration.py | 2 +- sdks/python/openapi-config.yaml | 2 +- sdks/python/pyproject.toml | 2 +- sdks/python/setup.py | 2 +- sdks/ruby/.travis.yml | 2 +- sdks/ruby/Gemfile.lock | 18 ++++--- sdks/ruby/README.md | 8 +-- sdks/ruby/VERSION | 2 +- sdks/ruby/lib/dropbox-sign/version.rb | 2 +- sdks/ruby/openapi-config.yaml | 2 +- src/Hello/Release/UpdateVersion.php | 16 ++++-- update-dev-versions | 50 +++++++++++++++++++ 51 files changed, 146 insertions(+), 76 deletions(-) create mode 100755 update-dev-versions diff --git a/README.md b/README.md index b31036e6a..7b1abddb4 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,16 @@ The [reset-sdks](reset-sdks) script resets SDK repos in [/repos](repos) back to ./reset-sdks python,node,ruby # reset specific SDKs ``` +### Updating Dev Versions + +After a release, the dev versions in [/sdks](sdks) should be bumped to match. The [update-dev-versions](update-dev-versions) script reads the released version from `repos/[SDK]/VERSION` and updates `sdks/[SDK]/VERSION` and `sdks/[SDK]/openapi-config.yaml` with the corresponding `-dev` suffix (e.g. `1.11.0` -> `1.11-dev`). + +```bash +./update-dev-versions # all SDKs +./update-dev-versions ruby # single SDK +./update-dev-versions python,node # specific SDKs +``` + ### Changes to Generated SDK Code We generate our SDKs using the [OpenAPI Generator](https://openapi-generator.tech/) tool. This tool reads the contents of the [openapi-sdk.yaml](openapi-sdk.yaml) file. It also reads related examples from the [/examples](examples) directory and embeds the contents into the generated documentation. diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index 32be7f086..414467bc4 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -23,7 +23,7 @@ directory that corresponds to the file you want updated. This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 3.0.0 -- SDK version: 2.1-dev +- SDK version: 2.2-dev - Generator version: 7.12.0 - Build package: org.openapitools.codegen.languages.CSharpClientCodegen diff --git a/sdks/dotnet/VERSION b/sdks/dotnet/VERSION index 35468ac2c..c78c4fff9 100644 --- a/sdks/dotnet/VERSION +++ b/sdks/dotnet/VERSION @@ -1 +1 @@ -2.1-dev +2.2-dev diff --git a/sdks/dotnet/openapi-config.yaml b/sdks/dotnet/openapi-config.yaml index c2be390cb..11d2095b9 100644 --- a/sdks/dotnet/openapi-config.yaml +++ b/sdks/dotnet/openapi-config.yaml @@ -6,7 +6,7 @@ additionalProperties: packageCompany: Dropbox Sign API Team packageCopyright: Dropbox 2024 packageDescription: Client library for using the Dropbox Sign API - packageVersion: 2.1-dev + packageVersion: 2.2-dev packageTitle: Dropbox Sign .Net SDK sortModelPropertiesByRequiredFlag: true optionalEmitDefaultValues: true diff --git a/sdks/dotnet/src/Dropbox.Sign/Client/Configuration.cs b/sdks/dotnet/src/Dropbox.Sign/Client/Configuration.cs index c4a1b9cc3..0903fe5c0 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Client/Configuration.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Client/Configuration.cs @@ -36,7 +36,7 @@ public class Configuration : IReadableConfiguration /// Version of the package. /// /// Version of the package. - public const string Version = "2.1-dev"; + public const string Version = "2.2-dev"; /// /// Identifier for ISO 8601 DateTime Format @@ -120,7 +120,7 @@ public class Configuration : IReadableConfiguration public Configuration() { Proxy = null; - UserAgent = WebUtility.UrlEncode("OpenAPI-Generator/2.1-dev/csharp"); + UserAgent = WebUtility.UrlEncode("OpenAPI-Generator/2.2-dev/csharp"); BasePath = "https://api.hellosign.com/v3"; DefaultHeaders = new ConcurrentDictionary(); ApiKey = new ConcurrentDictionary(); @@ -567,7 +567,7 @@ public static string ToDebugReport() report += " OS: " + System.Environment.OSVersion + "\n"; report += " .NET Framework Version: " + System.Environment.Version + "\n"; report += " Version of the API: 3.0.0\n"; - report += " SDK Package Version: 2.1-dev\n"; + report += " SDK Package Version: 2.2-dev\n"; return report; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Dropbox.Sign.csproj b/sdks/dotnet/src/Dropbox.Sign/Dropbox.Sign.csproj index 59b3a6595..da6c57dc7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Dropbox.Sign.csproj +++ b/sdks/dotnet/src/Dropbox.Sign/Dropbox.Sign.csproj @@ -12,7 +12,7 @@ Client library for using the Dropbox Sign API Dropbox 2024 Dropbox.Sign - 2.1-dev + 2.2-dev bin\$(Configuration)\$(TargetFramework)\Dropbox.Sign.xml https://github.com/hellosign/dropbox-sign-dotnet.git git diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index 26192ef39..7ea39626e 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -55,7 +55,7 @@ Add this dependency to your project's POM: com.dropbox.sign dropbox-sign - 1.10-dev + 1.11-dev compile ``` @@ -71,7 +71,7 @@ Add this dependency to your project's build file: } dependencies { - implementation "com.dropbox.sign:dropbox-sign:1.10-dev" + implementation "com.dropbox.sign:dropbox-sign:1.11-dev" } ``` @@ -85,7 +85,7 @@ mvn clean package Then manually install the following JARs: -- `target/dropbox-sign-1.10-dev.jar` +- `target/dropbox-sign-1.11-dev.jar` - `target/lib/*.jar` ## Getting Started @@ -477,7 +477,7 @@ apisupport@hellosign.com This Java 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.11-dev` - Build package: `org.openapitools.codegen.languages.JavaClientCodegen` diff --git a/sdks/java-v1/VERSION b/sdks/java-v1/VERSION index 1a9d86ec7..655297a20 100644 --- a/sdks/java-v1/VERSION +++ b/sdks/java-v1/VERSION @@ -1 +1 @@ -1.10-dev +1.11-dev diff --git a/sdks/java-v1/build.gradle b/sdks/java-v1/build.gradle index e4b936424..163f24e24 100644 --- a/sdks/java-v1/build.gradle +++ b/sdks/java-v1/build.gradle @@ -21,7 +21,7 @@ apply plugin: 'signing' group = 'com.dropbox.sign' archivesBaseName = 'dropbox-sign' -version = '1.10-dev' +version = '1.11-dev' sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/sdks/java-v1/build.sbt b/sdks/java-v1/build.sbt index 2cdb5a19b..214c47d8c 100644 --- a/sdks/java-v1/build.sbt +++ b/sdks/java-v1/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "com.dropbox.sign", name := "dropbox-sign", - version := "1.10-dev", + version := "1.11-dev", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), Compile / javacOptions ++= Seq("-Xlint:deprecation"), diff --git a/sdks/java-v1/gradle.properties b/sdks/java-v1/gradle.properties index f54a23f9c..aef361e60 100644 --- a/sdks/java-v1/gradle.properties +++ b/sdks/java-v1/gradle.properties @@ -6,7 +6,7 @@ #target = android GROUP=com.dropbox.sign POM_ARTIFACT_ID=dropbox-sign -VERSION_NAME=1.10-dev +VERSION_NAME=1.11-dev POM_NAME=Dropbox Sign Java SDK POM_DESCRIPTION=Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v1/openapi-config.yaml b/sdks/java-v1/openapi-config.yaml index 948b9b03e..4427e6104 100644 --- a/sdks/java-v1/openapi-config.yaml +++ b/sdks/java-v1/openapi-config.yaml @@ -16,7 +16,7 @@ additionalProperties: groupId: com.dropbox.sign artifactId: dropbox-sign artifactName: Dropbox Sign Java SDK - artifactVersion: "1.10-dev" + artifactVersion: "1.11-dev" artifactUrl: https://github.com/hellosign/dropbox-sign-java artifactDescription: Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! scmConnection: scm:git:git://github.com/hellosign/dropbox-sign-java.git diff --git a/sdks/java-v1/pom.xml b/sdks/java-v1/pom.xml index e22f8f1ce..b499f09a3 100644 --- a/sdks/java-v1/pom.xml +++ b/sdks/java-v1/pom.xml @@ -5,7 +5,7 @@ dropbox-sign jar dropbox-sign - 1.10-dev + 1.11-dev https://github.com/hellosign/dropbox-sign-java Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java b/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java index e7af3ef7e..671efa962 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/ApiClient.java @@ -147,7 +147,7 @@ public ApiClient(Map authMap) { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/1.10-dev/java"); + setUserAgent("OpenAPI-Generator/1.11-dev/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap<>(); diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java b/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java index ddcbd7148..654d69f1d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/Configuration.java @@ -16,7 +16,7 @@ value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class Configuration { - public static final String VERSION = "1.10-dev"; + public static final String VERSION = "1.11-dev"; private static volatile ApiClient defaultApiClient = new ApiClient(); diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index 944eb8465..91850482a 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -56,7 +56,7 @@ Add this dependency to your project's POM: com.dropbox.sign dropbox-sign - 2.6-dev + 2.7-dev compile ``` @@ -72,7 +72,7 @@ Add this dependency to your project's build file: } dependencies { - implementation "com.dropbox.sign:dropbox-sign:2.6-dev" + implementation "com.dropbox.sign:dropbox-sign:2.7-dev" } ``` @@ -86,7 +86,7 @@ mvn clean package Then manually install the following JARs: -- `target/dropbox-sign-2.6-dev.jar` +- `target/dropbox-sign-2.7-dev.jar` - `target/lib/*.jar` ## Getting Started @@ -453,7 +453,7 @@ apisupport@hellosign.com This Java package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: `3.0.0` - - Package version: `2.6-dev` + - Package version: `2.7-dev` - Build package: `org.openapitools.codegen.languages.JavaClientCodegen` diff --git a/sdks/java-v2/VERSION b/sdks/java-v2/VERSION index 7e5f9585b..19686912e 100644 --- a/sdks/java-v2/VERSION +++ b/sdks/java-v2/VERSION @@ -1 +1 @@ -2.6-dev +2.7-dev diff --git a/sdks/java-v2/build.gradle b/sdks/java-v2/build.gradle index 52e767e5a..8fc1583c4 100644 --- a/sdks/java-v2/build.gradle +++ b/sdks/java-v2/build.gradle @@ -21,7 +21,7 @@ apply plugin: 'signing' group = 'com.dropbox.sign' archivesBaseName = 'dropbox-sign' -version = '2.6-dev' +version = '2.7-dev' sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/sdks/java-v2/build.sbt b/sdks/java-v2/build.sbt index 344a1c513..0c4aa86e0 100644 --- a/sdks/java-v2/build.sbt +++ b/sdks/java-v2/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "com.dropbox.sign", name := "dropbox-sign", - version := "2.6-dev", + version := "2.7-dev", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), Compile / javacOptions ++= Seq("-Xlint:deprecation"), diff --git a/sdks/java-v2/gradle.properties b/sdks/java-v2/gradle.properties index ea880dd79..13378da6d 100644 --- a/sdks/java-v2/gradle.properties +++ b/sdks/java-v2/gradle.properties @@ -6,7 +6,7 @@ #target = android GROUP=com.dropbox.sign POM_ARTIFACT_ID=dropbox-sign -VERSION_NAME=2.6-dev +VERSION_NAME=2.7-dev POM_NAME=Dropbox Sign Java SDK POM_DESCRIPTION=Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v2/openapi-config.yaml b/sdks/java-v2/openapi-config.yaml index 3acf83162..0808a63d6 100644 --- a/sdks/java-v2/openapi-config.yaml +++ b/sdks/java-v2/openapi-config.yaml @@ -18,7 +18,7 @@ additionalProperties: groupId: com.dropbox.sign artifactId: dropbox-sign artifactName: Dropbox Sign Java SDK - artifactVersion: "2.6-dev" + artifactVersion: "2.7-dev" artifactUrl: https://github.com/hellosign/dropbox-sign-java artifactDescription: Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! scmConnection: scm:git:git://github.com/hellosign/dropbox-sign-java.git diff --git a/sdks/java-v2/pom.xml b/sdks/java-v2/pom.xml index 185a8cea2..089494e65 100644 --- a/sdks/java-v2/pom.xml +++ b/sdks/java-v2/pom.xml @@ -5,7 +5,7 @@ dropbox-sign jar dropbox-sign - 2.6-dev + 2.7-dev https://github.com/hellosign/dropbox-sign-java Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds! diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java b/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java index c40bc99ca..7fd787cbc 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/ApiClient.java @@ -159,7 +159,7 @@ public ApiClient(Map authMap) { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/2.6-dev/java"); + setUserAgent("OpenAPI-Generator/2.7-dev/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap<>(); diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java b/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java index f3f6a16d3..3f2f61734 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/Configuration.java @@ -15,7 +15,7 @@ @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class Configuration { - public static final String VERSION = "2.6-dev"; + public static final String VERSION = "2.7-dev"; private static volatile ApiClient defaultApiClient = new ApiClient(); diff --git a/sdks/node/VERSION b/sdks/node/VERSION index 1a9d86ec7..655297a20 100644 --- a/sdks/node/VERSION +++ b/sdks/node/VERSION @@ -1 +1 @@ -1.10-dev +1.11-dev diff --git a/sdks/node/api/apis.ts b/sdks/node/api/apis.ts index 4522d7dce..137e76a1e 100644 --- a/sdks/node/api/apis.ts +++ b/sdks/node/api/apis.ts @@ -38,7 +38,7 @@ export const queryParamsSerializer = (params) => { return Qs.stringify(params, { arrayFormat: "brackets" }); }; -export const USER_AGENT = "OpenAPI-Generator/1.10-dev/node"; +export const USER_AGENT = "OpenAPI-Generator/1.11-dev/node"; /** * Generates an object containing form data. diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 6887f5b9c..a1419df7a 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -36333,7 +36333,7 @@ var HttpError = class extends Error { var queryParamsSerializer = (params) => { return import_qs.default.stringify(params, { arrayFormat: "brackets" }); }; -var USER_AGENT = "OpenAPI-Generator/1.10-dev/node"; +var USER_AGENT = "OpenAPI-Generator/1.11-dev/node"; var generateFormData = (obj, typemap) => { const data = {}; let localVarUseFormData = false; diff --git a/sdks/node/openapi-config.yaml b/sdks/node/openapi-config.yaml index 592ddc1fd..5ce5d4f20 100644 --- a/sdks/node/openapi-config.yaml +++ b/sdks/node/openapi-config.yaml @@ -2,7 +2,7 @@ generatorName: typescript-node typeMappings: {} additionalProperties: npmName: "@dropbox/sign" - npmVersion: 1.10-dev + npmVersion: 1.11-dev supportsES6: true apiDocPath: ./docs/api modelDocPath: ./docs/model diff --git a/sdks/node/package-lock.json b/sdks/node/package-lock.json index dbfa0f71d..dcc03ad23 100644 --- a/sdks/node/package-lock.json +++ b/sdks/node/package-lock.json @@ -1,12 +1,12 @@ { "name": "@dropbox/sign", - "version": "1.10-dev", + "version": "1.11-dev", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@dropbox/sign", - "version": "1.10-dev", + "version": "1.11-dev", "dependencies": { "axios": "^1.8.2", "bluebird": "^3.7.2", diff --git a/sdks/node/package.json b/sdks/node/package.json index a88915ed1..69a7be449 100644 --- a/sdks/node/package.json +++ b/sdks/node/package.json @@ -1,6 +1,6 @@ { "name": "@dropbox/sign", - "version": "1.10-dev", + "version": "1.11-dev", "description": "Official Node client for Dropbox Sign", "repository": { "type": "git", diff --git a/sdks/node/types/api/apis.d.ts b/sdks/node/types/api/apis.d.ts index 3e7e1c8eb..ff111ded7 100644 --- a/sdks/node/types/api/apis.d.ts +++ b/sdks/node/types/api/apis.d.ts @@ -23,7 +23,7 @@ export interface returnTypeI { body?: any; } export declare const queryParamsSerializer: (params: any) => string; -export declare const USER_AGENT = "OpenAPI-Generator/1.10-dev/node"; +export declare const USER_AGENT = "OpenAPI-Generator/1.11-dev/node"; export declare const generateFormData: (obj: any, typemap: AttributeTypeMap) => { localVarUseFormData: boolean; data: object; diff --git a/sdks/php/README.md b/sdks/php/README.md index b247c3b43..d510976a0 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -53,7 +53,7 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow ```json { "require": { - "dropbox/sign": "^1.10.0" + "dropbox/sign": "^1.11.0" }, "minimum-stability": "dev" } @@ -64,7 +64,7 @@ Then run `composer install` Alternatively, install directly with ``` -composer require dropbox/sign:^1.10.0 +composer require dropbox/sign:^1.11.0 ``` ## Getting Started @@ -447,6 +447,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.11-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..655297a20 100644 --- a/sdks/php/VERSION +++ b/sdks/php/VERSION @@ -1 +1 @@ -1.10-dev +1.11-dev diff --git a/sdks/php/openapi-config.yaml b/sdks/php/openapi-config.yaml index da279249a..9ca2503f1 100644 --- a/sdks/php/openapi-config.yaml +++ b/sdks/php/openapi-config.yaml @@ -1,8 +1,8 @@ generatorName: php additionalProperties: packageName: dropbox/sign - packageVersion: "^1.10.0" - artifactVersion: 1.10-dev + packageVersion: "^1.11.0" + artifactVersion: 1.11-dev invokerPackage: "Dropbox\\Sign" sortModelPropertiesByRequiredFlag: true srcBasePath: src diff --git a/sdks/php/src/Configuration.php b/sdks/php/src/Configuration.php index cbd697cb4..c81f81d2d 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.11-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.11-dev' . PHP_EOL; $report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL; return $report; diff --git a/sdks/python/README.md b/sdks/python/README.md index 870a2a1a6..1837792ca 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -49,7 +49,7 @@ Python 3.8+ Install using `pip`: ```shell -python3 -m pip install dropbox-sign==1.10-dev +python3 -m pip install dropbox-sign==1.11-dev ``` Alternatively: @@ -400,6 +400,6 @@ apisupport@hellosign.com This Python 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.11-dev - Build package: org.openapitools.codegen.languages.PythonClientCodegen diff --git a/sdks/python/VERSION b/sdks/python/VERSION index 1a9d86ec7..655297a20 100644 --- a/sdks/python/VERSION +++ b/sdks/python/VERSION @@ -1 +1 @@ -1.10-dev +1.11-dev diff --git a/sdks/python/dropbox_sign/__init__.py b/sdks/python/dropbox_sign/__init__.py index 785146d22..aac250c6c 100644 --- a/sdks/python/dropbox_sign/__init__.py +++ b/sdks/python/dropbox_sign/__init__.py @@ -14,7 +14,7 @@ Do not edit the class manually. """ # noqa: E501 -__version__ = "1.10-dev" +__version__ = "1.11-dev" # import apis into sdk package from dropbox_sign.apis import * diff --git a/sdks/python/dropbox_sign/api_client.py b/sdks/python/dropbox_sign/api_client.py index b90e8029a..008f7a64a 100644 --- a/sdks/python/dropbox_sign/api_client.py +++ b/sdks/python/dropbox_sign/api_client.py @@ -89,7 +89,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = "OpenAPI-Generator/1.10-dev/python" + self.user_agent = "OpenAPI-Generator/1.11-dev/python" self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/sdks/python/dropbox_sign/configuration.py b/sdks/python/dropbox_sign/configuration.py index 7247bd547..15be2f037 100644 --- a/sdks/python/dropbox_sign/configuration.py +++ b/sdks/python/dropbox_sign/configuration.py @@ -546,7 +546,7 @@ def to_debug_report(self) -> str: "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: 3.0.0\n" - "SDK Package Version: 1.10-dev".format( + "SDK Package Version: 1.11-dev".format( env=sys.platform, pyversion=sys.version ) ) diff --git a/sdks/python/openapi-config.yaml b/sdks/python/openapi-config.yaml index d76c83c77..750aa245d 100644 --- a/sdks/python/openapi-config.yaml +++ b/sdks/python/openapi-config.yaml @@ -5,7 +5,7 @@ additionalProperties: generatorLanguageVersion: ">=3.8" packageName: dropbox_sign projectName: dropbox-sign - packageVersion: 1.10-dev + packageVersion: 1.11-dev sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true packageAuthor: Dropbox Sign API Team diff --git a/sdks/python/pyproject.toml b/sdks/python/pyproject.toml index 704fa862f..472a81218 100644 --- a/sdks/python/pyproject.toml +++ b/sdks/python/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "dropbox_sign" -version = "1.10-dev" +version = "1.11-dev" description = "Dropbox Sign API" authors = ["Official Python SDK for the Dropbox Sign API "] license = "MIT" diff --git a/sdks/python/setup.py b/sdks/python/setup.py index ad2afcd55..ed66905fd 100644 --- a/sdks/python/setup.py +++ b/sdks/python/setup.py @@ -23,7 +23,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "dropbox-sign" -VERSION = "1.10-dev" +VERSION = "1.11-dev" PYTHON_REQUIRES = ">= 3.8" REQUIRES = [ "urllib3 >= 1.25.3, < 3.0.0", diff --git a/sdks/ruby/.travis.yml b/sdks/ruby/.travis.yml index d1a9cac09..6e5d2b9e5 100644 --- a/sdks/ruby/.travis.yml +++ b/sdks/ruby/.travis.yml @@ -8,4 +8,4 @@ script: - bundle install --path vendor/bundle - bundle exec rspec - gem build dropbox-sign.gemspec - - gem install ./dropbox-sign-1.10-dev.gem + - gem install ./dropbox-sign-1.11-dev.gem diff --git a/sdks/ruby/Gemfile.lock b/sdks/ruby/Gemfile.lock index 96c3207b9..2d75eddc4 100644 --- a/sdks/ruby/Gemfile.lock +++ b/sdks/ruby/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - dropbox-sign (1.10.pre.dev) + dropbox-sign (1.11.pre.dev) typhoeus (~> 1.0, >= 1.0.1) GEM @@ -11,17 +11,19 @@ GEM byebug (11.1.3) coderay (1.1.3) diff-lcs (1.5.1) - ethon (0.16.0) + ethon (0.18.0) ffi (>= 1.15.0) - ffi (1.17.2-aarch64-linux-gnu) - ffi (1.17.2-arm64-darwin) - ffi (1.17.2-x86_64-darwin) - ffi (1.17.2-x86_64-linux-gnu) + logger + ffi (1.17.4-aarch64-linux-gnu) + ffi (1.17.4-arm64-darwin) + ffi (1.17.4-x86_64-darwin) + ffi (1.17.4-x86_64-linux-gnu) json (2.7.2) json_spec (1.1.5) multi_json (~> 1.0) rspec (>= 2.0, < 4.0) language_server-protocol (3.17.0.3) + logger (1.7.0) method_source (1.1.0) multi_json (1.15.0) parallel (1.26.3) @@ -64,8 +66,8 @@ GEM rubocop-ast (1.32.3) parser (>= 3.3.1.0) ruby-progressbar (1.13.0) - typhoeus (1.4.1) - ethon (>= 0.9.0) + typhoeus (1.6.0) + ethon (>= 0.18.0) unicode-display_width (2.5.0) PLATFORMS diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index c7b4bbae2..4d11460d2 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -25,7 +25,7 @@ directory that corresponds to the file you want updated. This SDK 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.11-dev - Generator version: 7.12.0 - Build package: org.openapitools.codegen.languages.RubyClientCodegen @@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec Then install the gem locally: ```shell -gem install ./dropbox-sign-1.10-dev.gem +gem install ./dropbox-sign-1.11-dev.gem ``` -(for development, run `gem install --dev ./dropbox-sign-1.10-dev.gem` to install the development dependencies) +(for development, run `gem install --dev ./dropbox-sign-1.11-dev.gem` to install the development dependencies) Finally add this to the Gemfile: - gem 'dropbox-sign', '~> 1.10-dev' + gem 'dropbox-sign', '~> 1.11-dev' ### Install from Git diff --git a/sdks/ruby/VERSION b/sdks/ruby/VERSION index 1a9d86ec7..655297a20 100644 --- a/sdks/ruby/VERSION +++ b/sdks/ruby/VERSION @@ -1 +1 @@ -1.10-dev +1.11-dev diff --git a/sdks/ruby/lib/dropbox-sign/version.rb b/sdks/ruby/lib/dropbox-sign/version.rb index 4593fa5d8..c05458cc7 100644 --- a/sdks/ruby/lib/dropbox-sign/version.rb +++ b/sdks/ruby/lib/dropbox-sign/version.rb @@ -14,5 +14,5 @@ module Dropbox end module Dropbox::Sign - VERSION = '1.10-dev' + VERSION = '1.11-dev' end diff --git a/sdks/ruby/openapi-config.yaml b/sdks/ruby/openapi-config.yaml index 7f271e847..bc8f3df51 100644 --- a/sdks/ruby/openapi-config.yaml +++ b/sdks/ruby/openapi-config.yaml @@ -9,7 +9,7 @@ additionalProperties: gemName: dropbox-sign gemRequiredRubyVersion: '>= 2.7' moduleName: "Dropbox::Sign" - gemVersion: 1.10-dev + gemVersion: 1.11-dev sortModelPropertiesByRequiredFlag: true legacyDiscriminatorBehavior: true gitUserId: hellosign diff --git a/src/Hello/Release/UpdateVersion.php b/src/Hello/Release/UpdateVersion.php index e6ae7bd59..bda0f60a4 100644 --- a/src/Hello/Release/UpdateVersion.php +++ b/src/Hello/Release/UpdateVersion.php @@ -116,11 +116,11 @@ public function run(): void throw new Exception("File {$filename} is empty"); } - /** - * ruby Gemfile.lock has different format - * 1.4-dev turns to 1.4.pre.dev - */ if ($this->sdk === 'ruby' && $filename === 'Gemfile.lock') { + /** + * ruby Gemfile.lock has different format + * 1.4-dev turns to 1.4.pre.dev + */ $contents = preg_replace( pattern: '/dropbox-sign \((.*)\)/i', replacement: "dropbox-sign ({$this->version})", @@ -128,6 +128,14 @@ public function run(): void ); echo $contents; + } elseif ($this->sdk === 'php' && $filename === 'openapi-config.yaml') { + // packageVersion uses composer constraint format (^X.Y.Z) + $contents = str_replace($this->current_version, $this->version, $contents); + $contents = preg_replace( + pattern: '/packageVersion:\s*"\^[0-9]+\.[0-9]+\.[0-9]+"/', + replacement: "packageVersion: \"^{$this->version}\"", + subject: $contents, + ); } else { $contents = str_replace($this->current_version, $this->version, $contents); } diff --git a/update-dev-versions b/update-dev-versions new file mode 100755 index 000000000..949ddf80b --- /dev/null +++ b/update-dev-versions @@ -0,0 +1,50 @@ +#!/usr/bin/env bash + +set -e + +DIR=$(cd `dirname $0` && pwd) +ALL_SDKS=( dotnet java-v1 java-v2 node php python ruby ) +TARGET="${1:-all}" + +if [[ "${TARGET}" == "all" ]]; then + SDKS=("${ALL_SDKS[@]}") +else + IFS=',' read -ra SDKS <<< "${TARGET}" +fi + +for SDK in "${SDKS[@]}"; do + REPO_VERSION_FILE="${DIR}/repos/${SDK}/VERSION" + SDK_VERSION_FILE="${DIR}/sdks/${SDK}/VERSION" + SDK_CONFIG_FILE="${DIR}/sdks/${SDK}/openapi-config.yaml" + + if [[ ! -f "${REPO_VERSION_FILE}" ]]; then + printf "SKIP: %s (no repos/%s/VERSION)\n" "$SDK" "$SDK" + continue + fi + + RELEASED=$(cat "${REPO_VERSION_FILE}" | tr -d '[:space:]') + MAJOR=$(echo "$RELEASED" | cut -d. -f1) + MINOR=$(echo "$RELEASED" | cut -d. -f2) + NEW_DEV="${MAJOR}.${MINOR}-dev" + + OLD_DEV=$(cat "${SDK_VERSION_FILE}" | tr -d '[:space:]') + + if [[ "${OLD_DEV}" == "${NEW_DEV}" ]]; then + printf "SKIP: %s (already at %s)\n" "$SDK" "$NEW_DEV" + continue + fi + + printf "%-12s %s -> %s\n" "$SDK" "$OLD_DEV" "$NEW_DEV" + + echo "$NEW_DEV" > "${SDK_VERSION_FILE}" + + if [[ -f "${SDK_CONFIG_FILE}" ]]; then + sed -i '' "s/${OLD_DEV}/${NEW_DEV}/g" "${SDK_CONFIG_FILE}" + + if [[ "${SDK}" == "php" ]]; then + sed -i '' "s/packageVersion: \"\\^[0-9]*\\.[0-9]*\\.[0-9]*\"/packageVersion: \"^${RELEASED}\"/" "${SDK_CONFIG_FILE}" + fi + fi +done + +printf "\nDone. Dev versions updated in sdks/.\n" From 2a20dfcffac07dd5f703da59d76fff28c72403aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrzej=20Dani=C5=82owski?= Date: Wed, 13 May 2026 13:45:57 +0200 Subject: [PATCH 4/6] Adjust release script (#547) --- README.md | 17 ++++++------ copy-sdks => bake-sdk-release | 49 +++++++++++++++++++++-------------- bin/copy-examples-filtered | 4 +++ 3 files changed, 42 insertions(+), 28 deletions(-) rename copy-sdks => bake-sdk-release (84%) diff --git a/README.md b/README.md index 7b1abddb4..e7ac84992 100644 --- a/README.md +++ b/README.md @@ -84,25 +84,24 @@ Changes will appear against the [/sdks](sdks) directory. Make sure to include th ### Releasing SDKs -The [copy-sdks](copy-sdks) script copies built SDK files from [/sdks](sdks) into the [/repos](repos) directory, updates version numbers, commits, and pushes a release branch. +The [bake-sdk-release](bake-sdk-release) script copies built SDK files from [/sdks](sdks) into the [/repos](repos) directory, updates version numbers, commits, and pushes a release branch. You can release a single SDK with an explicit version: ```bash -./copy-sdks -t php -v 1.4.0 +./bake-sdk-release -t php -v 1.4.0 ``` -Or release multiple SDKs at once, with automatic version bumps (reads the current version from `repos/[SDK]/VERSION`): +Or release multiple SDKs at once. Without `-b` or `-v`, the current version from `repos/[SDK]/VERSION` is used as-is: ```bash -./copy-sdks -t python,node,ruby # specific SDKs, auto-bump minor -./copy-sdks -t all # all SDKs, auto-bump minor -./copy-sdks -t all -b patch # all SDKs, auto-bump patch -./copy-sdks -t all -b major # all SDKs, auto-bump major -./copy-sdks -t all -v 2.0.0 # all SDKs, explicit version +./bake-sdk-release -t all # all SDKs, keep current version +./bake-sdk-release -t all -b minor # all SDKs, bump minor +./bake-sdk-release -t all -b patch # all SDKs, bump patch +./bake-sdk-release -t all -v 2.0.0 # all SDKs, explicit version ``` -The `-b` flag accepts `major`, `minor` (default), or `patch`. +The `-b` flag accepts `major`, `minor`, or `patch`. The script shows a summary table of current and new versions and asks for confirmation before proceeding. diff --git a/copy-sdks b/bake-sdk-release similarity index 84% rename from copy-sdks rename to bake-sdk-release index 34f1186cd..5d8d86c30 100755 --- a/copy-sdks +++ b/bake-sdk-release @@ -7,7 +7,8 @@ SDKS=( dotnet java-v1 java-v2 node php python ruby ) SHOW_HELP=0 TARGET_SDK= TARGET_VERSION= -BUMP_TYPE=minor +BUMP_TYPE= +DRY_RUN=0 REPO_DOTNET="https://github.com/hellosign/dropbox-sign-dotnet.git" REPO_JAVA_V1="--branch v1 https://github.com/hellosign/dropbox-sign-java.git" @@ -19,7 +20,7 @@ REPO_RUBY="https://github.com/hellosign/dropbox-sign-ruby.git" REPO_MAIN_BRANCH="main" -while getopts ":t:v:b:h" opt; do +while getopts ":t:v:b:dh" opt; do case $opt in t) TARGET_SDK="$OPTARG" ;; @@ -27,6 +28,8 @@ while getopts ":t:v:b:h" opt; do ;; b) BUMP_TYPE="$OPTARG" ;; + d) DRY_RUN=1 + ;; h) SHOW_HELP=1 ;; \?) echo "Invalid option -$OPTARG" >&2 @@ -95,8 +98,10 @@ function main() { if [[ -n "${TARGET_VERSION}" ]]; then versions+=("${TARGET_VERSION}") - else + elif [[ -n "${BUMP_TYPE}" ]]; then versions+=("$(bump_version "$current_ver" "$BUMP_TYPE")") + else + versions+=("${current_ver}") fi done @@ -136,7 +141,7 @@ function main() { function show_help() { cat << EOF -Usage: copy-sdks [OPTION] +Usage: bake-sdk-release [OPTION] Copies build files for a given SDK into the repos/[SDK] directory. **WARNING** All files and directories present in the repos/[SDK] directory will @@ -146,15 +151,17 @@ Copies build files for a given SDK into the repos/[SDK] directory. valid: dotnet, java-v1, java-v2, node, php, python, ruby, all -v version of the SDK, ex: 1.4.0 if omitted, auto-bumps version from repos/[SDK]/VERSION --b bump type when -v is omitted: major, minor (default), or patch +-b bump version: major, minor, or patch + if omitted, uses current version from repos/[SDK]/VERSION +-d dry run: copy files and update versions but skip commit and push -h display this help and exit Examples: - copy-sdks -t php -v 1.4.0 # single SDK, explicit version - copy-sdks -t python,node,ruby # multiple SDKs, auto-bump minor - copy-sdks -t all # all SDKs, auto-bump minor - copy-sdks -t all -b patch # all SDKs, auto-bump patch - copy-sdks -t all -v 2.0.0 # all SDKs, same explicit version + bake-sdk-release -t php -v 1.4.0 # single SDK, explicit version + bake-sdk-release -t all -b minor # all SDKs, bump minor + bake-sdk-release -t all -b patch # all SDKs, bump patch + bake-sdk-release -t all # all SDKs, keep current version + bake-sdk-release -t python,node,ruby # specific SDKs, keep current version EOF exit 0 @@ -193,10 +200,12 @@ function copy_files() printf "Copying built files for the ${SDK} SDK to ${SDK_DIR}\n" pushd "${SDK_DIR}/" - git reset --hard origin/${REPO_MAIN_BRANCH} - git pull origin ${REPO_MAIN_BRANCH} - git checkout "release-${VERSION}" 2>/dev/null || git checkout -b "release-${VERSION}" - git rm -rf --cached . + git fetch origin + git checkout "release-${VERSION}" 2>/dev/null || { + git checkout ${REPO_MAIN_BRANCH} + git reset --hard origin/${REPO_MAIN_BRANCH} + git checkout -b "release-${VERSION}" + } popd @@ -207,8 +216,6 @@ function copy_files() pushd "${SDK_DIR}/" - git add . - rm -f "${SDK_DIR}/openapi-sdk.yaml" rm -rf "${SDK_DIR}/examples" mkdir -p "${SDK_DIR}/examples" @@ -233,9 +240,13 @@ function copy_files() php "${DIR}/bin/update-sdk-version.php" ${SDK} ${VERSION} - git add -A - git commit -m "Release ${VERSION}" - git push -u origin "release-${VERSION}" + if [[ "${DRY_RUN}" -eq 0 ]]; then + git add -A + git commit -m "Release ${VERSION}" + git push -u origin "release-${VERSION}" + else + printf "Dry run: skipping commit and push for %s\n" "$SDK" + fi popd } diff --git a/bin/copy-examples-filtered b/bin/copy-examples-filtered index 424a9b809..82367c82e 100755 --- a/bin/copy-examples-filtered +++ b/bin/copy-examples-filtered @@ -31,6 +31,10 @@ for FILE in "${SRC_DIR}"/*."${EXT}"; do [ -f "$FILE" ] || continue BASENAME=$(basename "$FILE" ".$EXT") + if [[ "$BASENAME" != *Example ]]; then + continue + fi + SKIP=0 for PASCAL in "${HIDDEN_PASCALS[@]}"; do if [ "$BASENAME" = "${PASCAL}Example" ]; then From e812bda8338f08068481c89bba8b344ea0cad5b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrzej=20Dani=C5=82owski?= Date: Mon, 18 May 2026 09:22:11 +0200 Subject: [PATCH 5/6] Adjust java release (#548) --- README.md | 3 +- .../close-and-release-repository.yml | 6 +- .../.github/workflows/github-actions.yml | 19 +++-- sdks/java-v1/build.gradle | 82 +++---------------- .../libraries/jersey2/build.gradle.mustache | 79 ++++-------------- .../close-and-release-repository.yml | 6 +- .../.github/workflows/github-actions.yml | 19 +++-- sdks/java-v2/build.gradle | 82 +++---------------- .../libraries/jersey3/build.gradle.mustache | 79 ++++-------------- 9 files changed, 84 insertions(+), 291 deletions(-) diff --git a/README.md b/README.md index e7ac84992..ae8934bf7 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,8 @@ Or release multiple SDKs at once. Without `-b` or `-v`, the current version from ./bake-sdk-release -t all # all SDKs, keep current version ./bake-sdk-release -t all -b minor # all SDKs, bump minor ./bake-sdk-release -t all -b patch # all SDKs, bump patch -./bake-sdk-release -t all -v 2.0.0 # all SDKs, explicit version +./bake-sdk-release -t all -v 2.0.0 # all SDKs, explicit version +./bake-sdk-release -t all -d # all SDKs, do a dry run - no commit, push ``` The `-b` flag accepts `major`, `minor`, or `patch`. diff --git a/sdks/java-v1/.github/workflows/close-and-release-repository.yml b/sdks/java-v1/.github/workflows/close-and-release-repository.yml index 4aed1f0c3..8f07b7ed9 100644 --- a/sdks/java-v1/.github/workflows/close-and-release-repository.yml +++ b/sdks/java-v1/.github/workflows/close-and-release-repository.yml @@ -4,7 +4,7 @@ on: workflow_dispatch: inputs: repository: - description: 'Manually trigger gradle closeAndReleaseRepository task in case of timeout from previous publishing' + description: 'Manually trigger release in case of timeout from previous publishing' jobs: closeAndReleaseRepository: @@ -20,7 +20,9 @@ jobs: java-version: 11 - name: Publish Release to Maven Central - run: ./gradlew closeAndReleaseRepository --no-daemon --no-parallel --repository ${{ inputs.repository }} + run: ./gradlew publishAndReleaseToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace env: ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} + ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }} + ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} diff --git a/sdks/java-v1/.github/workflows/github-actions.yml b/sdks/java-v1/.github/workflows/github-actions.yml index 913f790a6..8a5616e8d 100644 --- a/sdks/java-v1/.github/workflows/github-actions.yml +++ b/sdks/java-v1/.github/workflows/github-actions.yml @@ -47,23 +47,26 @@ jobs: distribution: 'zulu' java-version: 11 - - name: Upload Artifacts - run: ./gradlew publishToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace + - name: Retrieve version + run: echo "PACKAGE_VERSION=$(cat VERSION)" >> $GITHUB_ENV + + - name: Publish to Maven Central + run: ./gradlew publishAndReleaseToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace + if: "!endsWith(env.PACKAGE_VERSION, '-SNAPSHOT')" env: ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }} ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} - - name: Retrieve version - run: echo "PACKAGE_VERSION=$(cat VERSION)" >> $GITHUB_ENV - - - name: Publish Release to Maven Central - run: ./gradlew releaseRepository --no-daemon --no-parallel - if: "!endsWith(env.PACKAGE_VERSION, '-SNAPSHOT')" + - name: Publish Snapshot + run: ./gradlew publishToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace + if: "endsWith(env.PACKAGE_VERSION, '-SNAPSHOT')" env: ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} + ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }} + ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} # This job runs on merging to "v1" branch # Creates a new tag using the value in the VERSION file diff --git a/sdks/java-v1/build.gradle b/sdks/java-v1/build.gradle index 163f24e24..f4d6098ee 100644 --- a/sdks/java-v1/build.gradle +++ b/sdks/java-v1/build.gradle @@ -1,44 +1,33 @@ -buildscript { - repositories { - mavenCentral() - } - dependencies { - classpath 'com.android.tools.build:gradle:2.3.+' - classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' - classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.25.0' - } -} plugins { + id 'java' id 'com.vanniktech.maven.publish' version '0.34.0' id 'com.diffplug.spotless' version '6.25.0' } -apply plugin: 'java' -apply plugin: 'maven-publish' -apply plugin: 'signing' - group = 'com.dropbox.sign' -archivesBaseName = 'dropbox-sign' version = '1.11-dev' -sourceCompatibility = JavaVersion.VERSION_1_8 -targetCompatibility = JavaVersion.VERSION_1_8 + +base { + archivesName.set('dropbox-sign') +} + +java { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 +} repositories { mavenCentral() } -tasks.withType(JavaCompile) { +tasks.withType(JavaCompile).configureEach { options.encoding = 'UTF-8' } -if (JavaVersion.current().isJava8Compatible()) { - tasks.withType(Javadoc) { - // disable the crazy super-strict doclint tool in Java 8 - //noinspection SpellCheckingInspection +tasks.withType(Javadoc).configureEach { options.addStringOption('Xdoclint:none', '-quiet') - } } task javadocJar(type: Jar) { @@ -68,53 +57,6 @@ artifacts { archives javadocJar, sourcesJar, fatJar } -publishing { - publications { - mavenJava(MavenPublication) { - pom { - name = 'Dropbox Sign' - packaging = 'jar' - // optionally artifactId can be defined here - artifactId = 'dropbox-sign' - description = 'Use the Dropbox SIgn Java SDK to connect your Java app to Dropbox Sign\'s service in microseconds!' - url = 'https://www.hellosign.com/' - - scm { - connection = 'scm:git:git://github.com/hellosign/dropbox-sign-java.git' - developerConnection = 'scm:git:git@github.com:hellosign/dropbox-sign-java.git' - url = 'https://github.com/hellosign/dropbox-sign-java' - } - - licenses { - license { - name = 'MIT License' - url = 'http://www.opensource.org/licenses/mit-license.php' - } - } - - developers { - developer { - name = 'Dropbox Sign API Team' - email = 'apisupport@hellosign.com' - url = 'https://www.hellosign.com' - } - } - } - } - } - repositories { - maven { - def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/" - def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/" - url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl - credentials { - username findProperty('ossrhUsername') - password findProperty('ossrhPassword') - } - } - } -} - ext { swagger_annotations_version = "1.6.5" jackson_version = "2.17.1" diff --git a/sdks/java-v1/templates/libraries/jersey2/build.gradle.mustache b/sdks/java-v1/templates/libraries/jersey2/build.gradle.mustache index deeb879cb..2339cfe0f 100644 --- a/sdks/java-v1/templates/libraries/jersey2/build.gradle.mustache +++ b/sdks/java-v1/templates/libraries/jersey2/build.gradle.mustache @@ -7,6 +7,7 @@ group = '{{groupId}}' version = '{{artifactVersion}}' {{/useCustomTemplateCode}} +{{^useCustomTemplateCode}} buildscript { repositories { mavenCentral() @@ -14,30 +15,29 @@ buildscript { dependencies { classpath 'com.android.tools.build:gradle:2.3.+' classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' -{{^useCustomTemplateCode}} classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.3.0' -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.25.0' -{{/useCustomTemplateCode}} } } +{{/useCustomTemplateCode}} {{#useCustomTemplateCode}} plugins { + id 'java' id 'com.vanniktech.maven.publish' version '0.34.0' id 'com.diffplug.spotless' version '6.25.0' } -apply plugin: 'java' -apply plugin: 'maven-publish' -apply plugin: 'signing' - group = '{{groupId}}' -archivesBaseName = '{{artifactId}}' version = '{{artifactVersion}}' -sourceCompatibility = JavaVersion.VERSION_1_8 -targetCompatibility = JavaVersion.VERSION_1_8 + +base { + archivesName.set('{{artifactId}}') +} + +java { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 +} {{/useCustomTemplateCode}} repositories { @@ -123,16 +123,12 @@ if(hasProperty('target') && target == 'android') { } {{/useCustomTemplateCode}} {{#useCustomTemplateCode}} -tasks.withType(JavaCompile) { +tasks.withType(JavaCompile).configureEach { options.encoding = 'UTF-8' } -if (JavaVersion.current().isJava8Compatible()) { - tasks.withType(Javadoc) { - // disable the crazy super-strict doclint tool in Java 8 - //noinspection SpellCheckingInspection +tasks.withType(Javadoc).configureEach { options.addStringOption('Xdoclint:none', '-quiet') - } } task javadocJar(type: Jar) { @@ -161,53 +157,6 @@ processResources { artifacts { archives javadocJar, sourcesJar, fatJar } - -publishing { - publications { - mavenJava(MavenPublication) { - pom { - name = 'Dropbox Sign' - packaging = 'jar' - // optionally artifactId can be defined here - artifactId = '{{artifactId}}' - description = 'Use the Dropbox SIgn Java SDK to connect your Java app to Dropbox Sign\'s service in microseconds!' - url = 'https://www.hellosign.com/' - - scm { - connection = '{{scmConnection}}' - developerConnection = '{{scmDeveloperConnection}}' - url = '{{scmUrl}}' - } - - licenses { - license { - name = '{{licenseName}}' - url = 'http://www.opensource.org/licenses/mit-license.php' - } - } - - developers { - developer { - name = '{{developerName}}' - email = '{{developerEmail}}' - url = 'https://www.hellosign.com' - } - } - } - } - } - repositories { - maven { - def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/" - def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/" - url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl - credentials { - username findProperty('ossrhUsername') - password findProperty('ossrhPassword') - } - } - } -} {{/useCustomTemplateCode}} ext { diff --git a/sdks/java-v2/.github/workflows/close-and-release-repository.yml b/sdks/java-v2/.github/workflows/close-and-release-repository.yml index 4aed1f0c3..8f07b7ed9 100644 --- a/sdks/java-v2/.github/workflows/close-and-release-repository.yml +++ b/sdks/java-v2/.github/workflows/close-and-release-repository.yml @@ -4,7 +4,7 @@ on: workflow_dispatch: inputs: repository: - description: 'Manually trigger gradle closeAndReleaseRepository task in case of timeout from previous publishing' + description: 'Manually trigger release in case of timeout from previous publishing' jobs: closeAndReleaseRepository: @@ -20,7 +20,9 @@ jobs: java-version: 11 - name: Publish Release to Maven Central - run: ./gradlew closeAndReleaseRepository --no-daemon --no-parallel --repository ${{ inputs.repository }} + run: ./gradlew publishAndReleaseToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace env: ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} + ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }} + ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} diff --git a/sdks/java-v2/.github/workflows/github-actions.yml b/sdks/java-v2/.github/workflows/github-actions.yml index 8c8235f57..fb81028a6 100644 --- a/sdks/java-v2/.github/workflows/github-actions.yml +++ b/sdks/java-v2/.github/workflows/github-actions.yml @@ -47,23 +47,26 @@ jobs: distribution: 'zulu' java-version: 11 - - name: Upload Artifacts - run: ./gradlew publishToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace + - name: Retrieve version + run: echo "PACKAGE_VERSION=$(cat VERSION)" >> $GITHUB_ENV + + - name: Publish to Maven Central + run: ./gradlew publishAndReleaseToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace + if: "!endsWith(env.PACKAGE_VERSION, '-SNAPSHOT')" env: ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }} ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} - - name: Retrieve version - run: echo "PACKAGE_VERSION=$(cat VERSION)" >> $GITHUB_ENV - - - name: Publish Release to Maven Central - run: ./gradlew releaseRepository --no-daemon --no-parallel - if: "!endsWith(env.PACKAGE_VERSION, '-SNAPSHOT')" + - name: Publish Snapshot + run: ./gradlew publishToMavenCentral --no-daemon --no-parallel --no-configuration-cache --stacktrace + if: "endsWith(env.PACKAGE_VERSION, '-SNAPSHOT')" env: ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} + ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }} + ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} # This job runs on merging to "main" branch # Creates a new tag using the value in the VERSION file diff --git a/sdks/java-v2/build.gradle b/sdks/java-v2/build.gradle index 8fc1583c4..070450059 100644 --- a/sdks/java-v2/build.gradle +++ b/sdks/java-v2/build.gradle @@ -1,44 +1,33 @@ -buildscript { - repositories { - mavenCentral() - } - dependencies { - classpath 'com.android.tools.build:gradle:2.3.+' - classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' - classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.25.0' - } -} plugins { + id 'java' id 'com.vanniktech.maven.publish' version '0.34.0' id 'com.diffplug.spotless' version '6.25.0' } -apply plugin: 'java' -apply plugin: 'maven-publish' -apply plugin: 'signing' - group = 'com.dropbox.sign' -archivesBaseName = 'dropbox-sign' version = '2.7-dev' -sourceCompatibility = JavaVersion.VERSION_1_8 -targetCompatibility = JavaVersion.VERSION_1_8 + +base { + archivesName.set('dropbox-sign') +} + +java { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 +} repositories { mavenCentral() } -tasks.withType(JavaCompile) { +tasks.withType(JavaCompile).configureEach { options.encoding = 'UTF-8' } -if (JavaVersion.current().isJava8Compatible()) { - tasks.withType(Javadoc) { - // disable the crazy super-strict doclint tool in Java 8 - //noinspection SpellCheckingInspection +tasks.withType(Javadoc).configureEach { options.addStringOption('Xdoclint:none', '-quiet') - } } task javadocJar(type: Jar) { @@ -68,53 +57,6 @@ artifacts { archives javadocJar, sourcesJar, fatJar } -publishing { - publications { - mavenJava(MavenPublication) { - pom { - name = 'Dropbox Sign' - packaging = 'jar' - // optionally artifactId can be defined here - artifactId = 'dropbox-sign' - description = 'Use the Dropbox SIgn Java SDK to connect your Java app to Dropbox Sign\'s service in microseconds!' - url = 'https://www.hellosign.com/' - - scm { - connection = 'scm:git:git://github.com/hellosign/dropbox-sign-java.git' - developerConnection = 'scm:git:git@github.com:hellosign/dropbox-sign-java.git' - url = 'https://github.com/hellosign/dropbox-sign-java' - } - - licenses { - license { - name = 'MIT License' - url = 'http://www.opensource.org/licenses/mit-license.php' - } - } - - developers { - developer { - name = 'Dropbox Sign API Team' - email = 'apisupport@hellosign.com' - url = 'https://www.hellosign.com' - } - } - } - } - } - repositories { - maven { - def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/" - def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/" - url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl - credentials { - username findProperty('ossrhUsername') - password findProperty('ossrhPassword') - } - } - } -} - ext { swagger_annotations_version = "1.6.5" jackson_version = "2.17.1" diff --git a/sdks/java-v2/templates/libraries/jersey3/build.gradle.mustache b/sdks/java-v2/templates/libraries/jersey3/build.gradle.mustache index 8663e4b09..a154937ee 100644 --- a/sdks/java-v2/templates/libraries/jersey3/build.gradle.mustache +++ b/sdks/java-v2/templates/libraries/jersey3/build.gradle.mustache @@ -7,6 +7,7 @@ group = '{{groupId}}' version = '{{artifactVersion}}' {{/useCustomTemplateCode}} +{{^useCustomTemplateCode}} buildscript { repositories { mavenCentral() @@ -14,30 +15,29 @@ buildscript { dependencies { classpath 'com.android.tools.build:gradle:2.3.+' classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' -{{^useCustomTemplateCode}} classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.3.0' -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.25.0' -{{/useCustomTemplateCode}} } } +{{/useCustomTemplateCode}} {{#useCustomTemplateCode}} plugins { + id 'java' id 'com.vanniktech.maven.publish' version '0.34.0' id 'com.diffplug.spotless' version '6.25.0' } -apply plugin: 'java' -apply plugin: 'maven-publish' -apply plugin: 'signing' - group = '{{groupId}}' -archivesBaseName = '{{artifactId}}' version = '{{artifactVersion}}' -sourceCompatibility = JavaVersion.VERSION_1_8 -targetCompatibility = JavaVersion.VERSION_1_8 + +base { + archivesName.set('{{artifactId}}') +} + +java { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 +} {{/useCustomTemplateCode}} repositories { @@ -123,16 +123,12 @@ if(hasProperty('target') && target == 'android') { } {{/useCustomTemplateCode}} {{#useCustomTemplateCode}} -tasks.withType(JavaCompile) { +tasks.withType(JavaCompile).configureEach { options.encoding = 'UTF-8' } -if (JavaVersion.current().isJava8Compatible()) { - tasks.withType(Javadoc) { - // disable the crazy super-strict doclint tool in Java 8 - //noinspection SpellCheckingInspection +tasks.withType(Javadoc).configureEach { options.addStringOption('Xdoclint:none', '-quiet') - } } task javadocJar(type: Jar) { @@ -161,53 +157,6 @@ processResources { artifacts { archives javadocJar, sourcesJar, fatJar } - -publishing { - publications { - mavenJava(MavenPublication) { - pom { - name = 'Dropbox Sign' - packaging = 'jar' - // optionally artifactId can be defined here - artifactId = '{{artifactId}}' - description = 'Use the Dropbox SIgn Java SDK to connect your Java app to Dropbox Sign\'s service in microseconds!' - url = 'https://www.hellosign.com/' - - scm { - connection = '{{scmConnection}}' - developerConnection = '{{scmDeveloperConnection}}' - url = '{{scmUrl}}' - } - - licenses { - license { - name = '{{licenseName}}' - url = 'http://www.opensource.org/licenses/mit-license.php' - } - } - - developers { - developer { - name = '{{developerName}}' - email = '{{developerEmail}}' - url = 'https://www.hellosign.com' - } - } - } - } - } - repositories { - maven { - def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/" - def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/" - url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl - credentials { - username findProperty('ossrhUsername') - password findProperty('ossrhPassword') - } - } - } -} {{/useCustomTemplateCode}} ext { From a869233e8205e225bffdb3a728a9955041b3e6f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andrzej=20Dani=C5=82owski?= Date: Wed, 22 Jul 2026 16:10:39 +0200 Subject: [PATCH 6/6] Fix Ruby SDK silently swallowing API errors (SIGN-17019) (#553) Co-authored-by: Claude Opus 4.6 (1M context) --- sdks/ruby/lib/dropbox-sign/api/account_api.rb | 12 ++- sdks/ruby/lib/dropbox-sign/api/api_app_api.rb | 13 +++- .../lib/dropbox-sign/api/bulk_send_job_api.rb | 6 +- .../ruby/lib/dropbox-sign/api/embedded_api.rb | 6 +- sdks/ruby/lib/dropbox-sign/api/fax_api.rb | 13 +++- .../ruby/lib/dropbox-sign/api/fax_line_api.rb | 19 +++-- sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb | 6 +- sdks/ruby/lib/dropbox-sign/api/report_api.rb | 3 +- .../dropbox-sign/api/signature_request_api.rb | 56 +++++++++----- sdks/ruby/lib/dropbox-sign/api/team_api.rb | 28 ++++--- .../ruby/lib/dropbox-sign/api/template_api.rb | 31 +++++--- .../dropbox-sign/api/unclaimed_draft_api.rb | 12 ++- sdks/ruby/spec/api/error_handling_spec.rb | 73 +++++++++++++++++++ sdks/ruby/templates/api.mustache | 3 +- 14 files changed, 214 insertions(+), 67 deletions(-) create mode 100644 sdks/ruby/spec/api/error_handling_spec.rb diff --git a/sdks/ruby/lib/dropbox-sign/api/account_api.rb b/sdks/ruby/lib/dropbox-sign/api/account_api.rb index 454dd2144..93a66cc2f 100644 --- a/sdks/ruby/lib/dropbox-sign/api/account_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/account_api.rb @@ -111,7 +111,7 @@ def account_create_with_http_info(account_create_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -123,6 +123,7 @@ def account_create_with_http_info(account_create_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -205,7 +206,7 @@ def account_get_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -217,6 +218,7 @@ def account_get_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -314,7 +316,7 @@ def account_update_with_http_info(account_update_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -326,6 +328,7 @@ def account_update_with_http_info(account_update_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -423,7 +426,7 @@ def account_verify_with_http_info(account_verify_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -435,6 +438,7 @@ def account_verify_with_http_info(account_verify_request, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb b/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb index a6fb78541..55a35c719 100644 --- a/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/api_app_api.rb @@ -111,7 +111,7 @@ def api_app_create_with_http_info(api_app_create_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -123,6 +123,7 @@ def api_app_create_with_http_info(api_app_create_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -190,6 +191,7 @@ def api_app_delete_with_http_info(client_id, opts = {}) begin data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) rescue Dropbox::Sign::ApiError => e + raise e end if @api_client.config.debugging @@ -272,7 +274,7 @@ def api_app_get_with_http_info(client_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -284,6 +286,7 @@ def api_app_get_with_http_info(client_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -366,7 +369,7 @@ def api_app_list_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -378,6 +381,7 @@ def api_app_list_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -481,7 +485,7 @@ def api_app_update_with_http_info(client_id, api_app_update_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -493,6 +497,7 @@ def api_app_update_with_http_info(client_id, api_app_update_request, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb b/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb index 5f628409e..69bd2006d 100644 --- a/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/bulk_send_job_api.rb @@ -102,7 +102,7 @@ def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -114,6 +114,7 @@ def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -196,7 +197,7 @@ def bulk_send_job_list_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -208,6 +209,7 @@ def bulk_send_job_list_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb b/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb index 5724c4923..efbc7f927 100644 --- a/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/embedded_api.rb @@ -117,7 +117,7 @@ def embedded_edit_url_with_http_info(template_id, embedded_edit_url_request, opt range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -129,6 +129,7 @@ def embedded_edit_url_with_http_info(template_id, embedded_edit_url_request, opt e.message end + raise e end if @api_client.config.debugging @@ -211,7 +212,7 @@ def embedded_sign_url_with_http_info(signature_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -223,6 +224,7 @@ def embedded_sign_url_with_http_info(signature_id, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb index aac2bc905..f4cfda3a6 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -81,6 +81,7 @@ def fax_delete_with_http_info(fax_id, opts = {}) begin data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) rescue Dropbox::Sign::ApiError => e + raise e end if @api_client.config.debugging @@ -163,7 +164,7 @@ def fax_files_with_http_info(fax_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -175,6 +176,7 @@ def fax_files_with_http_info(fax_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -257,7 +259,7 @@ def fax_get_with_http_info(fax_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -269,6 +271,7 @@ def fax_get_with_http_info(fax_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -363,7 +366,7 @@ def fax_list_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -375,6 +378,7 @@ def fax_list_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -472,7 +476,7 @@ def fax_send_with_http_info(fax_send_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -484,6 +488,7 @@ def fax_send_with_http_info(fax_send_request, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb index 02d224ccb..3c8a86155 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb @@ -111,7 +111,7 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -123,6 +123,7 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -228,7 +229,7 @@ def fax_line_area_code_get_with_http_info(country, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -240,6 +241,7 @@ def fax_line_area_code_get_with_http_info(country, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -337,7 +339,7 @@ def fax_line_create_with_http_info(fax_line_create_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -349,6 +351,7 @@ def fax_line_create_with_http_info(fax_line_create_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -431,6 +434,7 @@ def fax_line_delete_with_http_info(fax_line_delete_request, opts = {}) begin data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) rescue Dropbox::Sign::ApiError => e + raise e end if @api_client.config.debugging @@ -514,7 +518,7 @@ def fax_line_get_with_http_info(number, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -526,6 +530,7 @@ def fax_line_get_with_http_info(number, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -614,7 +619,7 @@ def fax_line_list_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -626,6 +631,7 @@ def fax_line_list_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -723,7 +729,7 @@ def fax_line_remove_user_with_http_info(fax_line_remove_user_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -735,6 +741,7 @@ def fax_line_remove_user_with_http_info(fax_line_remove_user_request, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb index ae9af5a5c..24acc4fa4 100644 --- a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb @@ -111,7 +111,7 @@ def oauth_token_generate_with_http_info(o_auth_token_generate_request, opts = {} range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -123,6 +123,7 @@ def oauth_token_generate_with_http_info(o_auth_token_generate_request, opts = {} e.message end + raise e end if @api_client.config.debugging @@ -220,7 +221,7 @@ def oauth_token_refresh_with_http_info(o_auth_token_refresh_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -232,6 +233,7 @@ def oauth_token_refresh_with_http_info(o_auth_token_refresh_request, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/report_api.rb b/sdks/ruby/lib/dropbox-sign/api/report_api.rb index ee776ff00..9bbaf033d 100644 --- a/sdks/ruby/lib/dropbox-sign/api/report_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/report_api.rb @@ -111,7 +111,7 @@ def report_create_with_http_info(report_create_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -123,6 +123,7 @@ def report_create_with_http_info(report_create_request, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb index d2b968496..cb68136fa 100644 --- a/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/signature_request_api.rb @@ -111,7 +111,7 @@ def signature_request_bulk_create_embedded_with_template_with_http_info(signatur range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -123,6 +123,7 @@ def signature_request_bulk_create_embedded_with_template_with_http_info(signatur e.message end + raise e end if @api_client.config.debugging @@ -220,7 +221,7 @@ def signature_request_bulk_send_with_template_with_http_info(signature_request_b range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -232,6 +233,7 @@ def signature_request_bulk_send_with_template_with_http_info(signature_request_b e.message end + raise e end if @api_client.config.debugging @@ -299,6 +301,7 @@ def signature_request_cancel_with_http_info(signature_request_id, opts = {}) begin data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) rescue Dropbox::Sign::ApiError => e + raise e end if @api_client.config.debugging @@ -396,7 +399,7 @@ def signature_request_create_embedded_with_http_info(signature_request_create_em range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -408,6 +411,7 @@ def signature_request_create_embedded_with_http_info(signature_request_create_em e.message end + raise e end if @api_client.config.debugging @@ -505,7 +509,7 @@ def signature_request_create_embedded_with_template_with_http_info(signature_req range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -517,6 +521,7 @@ def signature_request_create_embedded_with_template_with_http_info(signature_req e.message end + raise e end if @api_client.config.debugging @@ -620,7 +625,7 @@ def signature_request_edit_with_http_info(signature_request_id, signature_reques range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -632,6 +637,7 @@ def signature_request_edit_with_http_info(signature_request_id, signature_reques e.message end + raise e end if @api_client.config.debugging @@ -735,7 +741,7 @@ def signature_request_edit_embedded_with_http_info(signature_request_id, signatu range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -747,6 +753,7 @@ def signature_request_edit_embedded_with_http_info(signature_request_id, signatu e.message end + raise e end if @api_client.config.debugging @@ -850,7 +857,7 @@ def signature_request_edit_embedded_with_template_with_http_info(signature_reque range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -862,6 +869,7 @@ def signature_request_edit_embedded_with_template_with_http_info(signature_reque e.message end + raise e end if @api_client.config.debugging @@ -965,7 +973,7 @@ def signature_request_edit_with_template_with_http_info(signature_request_id, si range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -977,6 +985,7 @@ def signature_request_edit_with_template_with_http_info(signature_request_id, si e.message end + raise e end if @api_client.config.debugging @@ -1066,7 +1075,7 @@ def signature_request_files_with_http_info(signature_request_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1078,6 +1087,7 @@ def signature_request_files_with_http_info(signature_request_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -1160,7 +1170,7 @@ def signature_request_files_as_data_uri_with_http_info(signature_request_id, opt range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1172,6 +1182,7 @@ def signature_request_files_as_data_uri_with_http_info(signature_request_id, opt e.message end + raise e end if @api_client.config.debugging @@ -1257,7 +1268,7 @@ def signature_request_files_as_file_url_with_http_info(signature_request_id, opt range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1269,6 +1280,7 @@ def signature_request_files_as_file_url_with_http_info(signature_request_id, opt e.message end + raise e end if @api_client.config.debugging @@ -1351,7 +1363,7 @@ def signature_request_get_with_http_info(signature_request_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1363,6 +1375,7 @@ def signature_request_get_with_http_info(signature_request_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -1451,7 +1464,7 @@ def signature_request_list_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1463,6 +1476,7 @@ def signature_request_list_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -1545,7 +1559,7 @@ def signature_request_release_hold_with_http_info(signature_request_id, opts = { range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1557,6 +1571,7 @@ def signature_request_release_hold_with_http_info(signature_request_id, opts = { e.message end + raise e end if @api_client.config.debugging @@ -1660,7 +1675,7 @@ def signature_request_remind_with_http_info(signature_request_id, signature_requ range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1672,6 +1687,7 @@ def signature_request_remind_with_http_info(signature_request_id, signature_requ e.message end + raise e end if @api_client.config.debugging @@ -1739,6 +1755,7 @@ def signature_request_remove_with_http_info(signature_request_id, opts = {}) begin data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) rescue Dropbox::Sign::ApiError => e + raise e end if @api_client.config.debugging @@ -1836,7 +1853,7 @@ def signature_request_send_with_http_info(signature_request_send_request, opts = range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1848,6 +1865,7 @@ def signature_request_send_with_http_info(signature_request_send_request, opts = e.message end + raise e end if @api_client.config.debugging @@ -1945,7 +1963,7 @@ def signature_request_send_with_template_with_http_info(signature_request_send_w range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1957,6 +1975,7 @@ def signature_request_send_with_template_with_http_info(signature_request_send_w e.message end + raise e end if @api_client.config.debugging @@ -2060,7 +2079,7 @@ def signature_request_update_with_http_info(signature_request_id, signature_requ range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -2072,6 +2091,7 @@ def signature_request_update_with_http_info(signature_request_id, signature_requ e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/team_api.rb b/sdks/ruby/lib/dropbox-sign/api/team_api.rb index 1002a2d6b..4fbe8cb85 100644 --- a/sdks/ruby/lib/dropbox-sign/api/team_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/team_api.rb @@ -114,7 +114,7 @@ def team_add_member_with_http_info(team_add_member_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -126,6 +126,7 @@ def team_add_member_with_http_info(team_add_member_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -223,7 +224,7 @@ def team_create_with_http_info(team_create_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -235,6 +236,7 @@ def team_create_with_http_info(team_create_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -296,6 +298,7 @@ def team_delete_with_http_info(opts = {}) begin data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) rescue Dropbox::Sign::ApiError => e + raise e end if @api_client.config.debugging @@ -372,7 +375,7 @@ def team_get_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -384,6 +387,7 @@ def team_get_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -463,7 +467,7 @@ def team_info_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -475,6 +479,7 @@ def team_info_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -554,7 +559,7 @@ def team_invites_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -566,6 +571,7 @@ def team_invites_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -662,7 +668,7 @@ def team_members_with_http_info(team_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -674,6 +680,7 @@ def team_members_with_http_info(team_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -771,7 +778,7 @@ def team_remove_member_with_http_info(team_remove_member_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -783,6 +790,7 @@ def team_remove_member_with_http_info(team_remove_member_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -879,7 +887,7 @@ def team_sub_teams_with_http_info(team_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -891,6 +899,7 @@ def team_sub_teams_with_http_info(team_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -988,7 +997,7 @@ def team_update_with_http_info(team_update_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1000,6 +1009,7 @@ def team_update_with_http_info(team_update_request, opts = {}) e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/template_api.rb b/sdks/ruby/lib/dropbox-sign/api/template_api.rb index c43bf9e06..a649223c1 100644 --- a/sdks/ruby/lib/dropbox-sign/api/template_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/template_api.rb @@ -117,7 +117,7 @@ def template_add_user_with_http_info(template_id, template_add_user_request, opt range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -129,6 +129,7 @@ def template_add_user_with_http_info(template_id, template_add_user_request, opt e.message end + raise e end if @api_client.config.debugging @@ -226,7 +227,7 @@ def template_create_with_http_info(template_create_request, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -238,6 +239,7 @@ def template_create_with_http_info(template_create_request, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -335,7 +337,7 @@ def template_create_embedded_draft_with_http_info(template_create_embedded_draft range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -347,6 +349,7 @@ def template_create_embedded_draft_with_http_info(template_create_embedded_draft e.message end + raise e end if @api_client.config.debugging @@ -414,6 +417,7 @@ def template_delete_with_http_info(template_id, opts = {}) begin data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) rescue Dropbox::Sign::ApiError => e + raise e end if @api_client.config.debugging @@ -503,7 +507,7 @@ def template_files_with_http_info(template_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -515,6 +519,7 @@ def template_files_with_http_info(template_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -597,7 +602,7 @@ def template_files_as_data_uri_with_http_info(template_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -609,6 +614,7 @@ def template_files_as_data_uri_with_http_info(template_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -694,7 +700,7 @@ def template_files_as_file_url_with_http_info(template_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -706,6 +712,7 @@ def template_files_as_file_url_with_http_info(template_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -788,7 +795,7 @@ def template_get_with_http_info(template_id, opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -800,6 +807,7 @@ def template_get_with_http_info(template_id, opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -896,7 +904,7 @@ def template_list_with_http_info(opts = {}) range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -908,6 +916,7 @@ def template_list_with_http_info(opts = {}) e.message end + raise e end if @api_client.config.debugging @@ -1011,7 +1020,7 @@ def template_remove_user_with_http_info(template_id, template_remove_user_reques range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1023,6 +1032,7 @@ def template_remove_user_with_http_info(template_id, template_remove_user_reques e.message end + raise e end if @api_client.config.debugging @@ -1126,7 +1136,7 @@ def template_update_files_with_http_info(template_id, template_update_files_requ range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -1138,6 +1148,7 @@ def template_update_files_with_http_info(template_id, template_update_files_requ e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb b/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb index 53ede8998..bf6e1587c 100644 --- a/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/unclaimed_draft_api.rb @@ -111,7 +111,7 @@ def unclaimed_draft_create_with_http_info(unclaimed_draft_create_request, opts = range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -123,6 +123,7 @@ def unclaimed_draft_create_with_http_info(unclaimed_draft_create_request, opts = e.message end + raise e end if @api_client.config.debugging @@ -220,7 +221,7 @@ def unclaimed_draft_create_embedded_with_http_info(unclaimed_draft_create_embedd range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -232,6 +233,7 @@ def unclaimed_draft_create_embedded_with_http_info(unclaimed_draft_create_embedd e.message end + raise e end if @api_client.config.debugging @@ -329,7 +331,7 @@ def unclaimed_draft_create_embedded_with_template_with_http_info(unclaimed_draft range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -341,6 +343,7 @@ def unclaimed_draft_create_embedded_with_template_with_http_info(unclaimed_draft e.message end + raise e end if @api_client.config.debugging @@ -444,7 +447,7 @@ def unclaimed_draft_edit_and_resend_with_http_info(signature_request_id, unclaim range_code = "4XX".split('').first range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "Dropbox::Sign::ErrorResponse" @@ -456,6 +459,7 @@ def unclaimed_draft_edit_and_resend_with_http_info(signature_request_id, unclaim e.message end + raise e end if @api_client.config.debugging diff --git a/sdks/ruby/spec/api/error_handling_spec.rb b/sdks/ruby/spec/api/error_handling_spec.rb new file mode 100644 index 000000000..b58460063 --- /dev/null +++ b/sdks/ruby/spec/api/error_handling_spec.rb @@ -0,0 +1,73 @@ +=begin +#Dropbox Sign API + +#Dropbox Sign v3 API + +The version of the OpenAPI document: 3.0.0 +Contact: apisupport@hellosign.com +Generated by: https://openapi-generator.tech +Generator version: 7.12.0 + +=end + +require 'spec_helper' +require_relative '../test_utils' + +describe 'Error Handling' do + context 'ApiError propagation' do + api = Dropbox::Sign::AccountApi.new + + it 'raises ApiError for 5XX server errors' do + set_expected_response(500, '{"error":{"error_msg":"Internal server error","error_name":"server_error"}}') + + expect { + api.account_get({ email_address: "test@example.com" }) + }.to raise_error(Dropbox::Sign::ApiError) { |e| + expect(e.code).to eq(500) + } + end + + it 'raises ApiError for 503 server errors' do + set_expected_response(503, '{"error":{"error_msg":"Service unavailable","error_name":"service_unavailable"}}') + + expect { + api.account_get({ email_address: "test@example.com" }) + }.to raise_error(Dropbox::Sign::ApiError) { |e| + expect(e.code).to eq(503) + } + end + + it 'raises ApiError for connection failures' do + Typhoeus.stub(/hellosign.com/) do + Typhoeus::Response.new( + :code => 0, + :return_message => "Connection refused" + ) + end + + expect { + api.account_get({ email_address: "test@example.com" }) + }.to raise_error(Dropbox::Sign::ApiError) { |e| + expect(e.code).to eq(0) + } + end + + it 'raises ApiError for timeout errors' do + Typhoeus.stub(/hellosign.com/) do + response = Typhoeus::Response.new( + :code => 0, + :return_message => "Timeout was reached", + :mock => true + ) + response.instance_variable_set(:@options, response.instance_variable_get(:@options).merge(return_code: :operation_timedout)) + response + end + + expect { + api.account_get({ email_address: "test@example.com" }) + }.to raise_error(Dropbox::Sign::ApiError) { |e| + expect(e.message).to include("timed out") + } + end + end +end diff --git a/sdks/ruby/templates/api.mustache b/sdks/ruby/templates/api.mustache index e5611a33d..cade90e77 100644 --- a/sdks/ruby/templates/api.mustache +++ b/sdks/ruby/templates/api.mustache @@ -307,7 +307,7 @@ module {{moduleName}} range_code_left = "#{range_code}00".to_i range_code_right = "#{range_code}99".to_i <%={{ }}=%> - if e.code >= range_code_left && e.code <= range_code_right + if e.code && e.code >= range_code_left && e.code <= range_code_right body = @api_client.convert_to_type( JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], "{{moduleName}}::{{{dataType}}}" @@ -338,6 +338,7 @@ module {{moduleName}} {{/dataType}} {{/responses}} {{/returnType}} + raise e end {{/useCustomTemplateCode}}