From c81d91509cb6e377f01e280b12a95fe465e7072c Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Tue, 15 Oct 2024 17:28:10 -0500 Subject: [PATCH 1/4] Improvements to Template response; reduces nullability --- openapi-raw.yaml | 202 ++++--- openapi-sdk.yaml | 202 ++++--- openapi.yaml | 202 ++++--- sdks/dotnet/docs/OAuthApi.md | 2 - sdks/dotnet/docs/OAuthTokenRefreshRequest.md | 2 +- ...lateCreateEmbeddedDraftResponseTemplate.md | 2 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/dotnet/docs/TemplateResponse.md | 2 +- sdks/dotnet/docs/TemplateResponseAccount.md | 2 +- .../docs/TemplateResponseAccountQuota.md | 2 +- sdks/dotnet/docs/TemplateResponseCCRole.md | 2 +- sdks/dotnet/docs/TemplateResponseDocument.md | 2 +- ...TemplateResponseDocumentCustomFieldBase.md | 2 +- ...lateResponseDocumentCustomFieldCheckbox.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 16 +- .../TemplateResponseDocumentFieldGroup.md | 2 +- .../TemplateResponseDocumentFieldGroupRule.md | 2 +- .../TemplateResponseDocumentFormFieldBase.md | 2 +- ...mplateResponseDocumentFormFieldCheckbox.md | 19 +- ...lateResponseDocumentFormFieldDateSigned.md | 19 +- ...mplateResponseDocumentFormFieldDropdown.md | 19 +- ...plateResponseDocumentFormFieldHyperlink.md | 19 +- ...mplateResponseDocumentFormFieldInitials.md | 19 +- .../TemplateResponseDocumentFormFieldRadio.md | 19 +- ...plateResponseDocumentFormFieldSignature.md | 19 +- .../TemplateResponseDocumentFormFieldText.md | 19 +- ...TemplateResponseDocumentStaticFieldBase.md | 2 +- ...lateResponseDocumentStaticFieldCheckbox.md | 16 +- ...teResponseDocumentStaticFieldDateSigned.md | 16 +- ...lateResponseDocumentStaticFieldDropdown.md | 16 +- ...ateResponseDocumentStaticFieldHyperlink.md | 16 +- ...lateResponseDocumentStaticFieldInitials.md | 16 +- ...emplateResponseDocumentStaticFieldRadio.md | 16 +- ...ateResponseDocumentStaticFieldSignature.md | 16 +- ...TemplateResponseDocumentStaticFieldText.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 2 +- .../dotnet/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../Model/OAuthTokenRefreshRequest.cs | 54 +- ...lateCreateEmbeddedDraftResponseTemplate.cs | 22 +- .../Model/TemplateCreateResponseTemplate.cs | 9 +- .../Dropbox.Sign/Model/TemplateResponse.cs | 301 +++++----- .../Model/TemplateResponseAccount.cs | 80 +-- .../Model/TemplateResponseAccountQuota.cs | 16 +- .../Model/TemplateResponseCCRole.cs | 9 +- .../Model/TemplateResponseDocument.cs | 87 ++- ...TemplateResponseDocumentCustomFieldBase.cs | 126 +++-- ...lateResponseDocumentCustomFieldCheckbox.cs | 16 +- ...TemplateResponseDocumentCustomFieldText.cs | 42 +- .../TemplateResponseDocumentFieldGroup.cs | 18 +- .../TemplateResponseDocumentFieldGroupRule.cs | 18 +- .../TemplateResponseDocumentFormFieldBase.cs | 125 ++-- ...mplateResponseDocumentFormFieldCheckbox.cs | 44 +- ...lateResponseDocumentFormFieldDateSigned.cs | 44 +- ...mplateResponseDocumentFormFieldDropdown.cs | 44 +- ...plateResponseDocumentFormFieldHyperlink.cs | 70 ++- ...mplateResponseDocumentFormFieldInitials.cs | 44 +- .../TemplateResponseDocumentFormFieldRadio.cs | 49 +- ...plateResponseDocumentFormFieldSignature.cs | 44 +- .../TemplateResponseDocumentFormFieldText.cs | 70 ++- ...TemplateResponseDocumentStaticFieldBase.cs | 100 ++-- ...lateResponseDocumentStaticFieldCheckbox.cs | 16 +- ...teResponseDocumentStaticFieldDateSigned.cs | 16 +- ...lateResponseDocumentStaticFieldDropdown.cs | 16 +- ...ateResponseDocumentStaticFieldHyperlink.cs | 16 +- ...lateResponseDocumentStaticFieldInitials.cs | 16 +- ...emplateResponseDocumentStaticFieldRadio.cs | 16 +- ...ateResponseDocumentStaticFieldSignature.cs | 16 +- ...TemplateResponseDocumentStaticFieldText.cs | 16 +- .../TemplateResponseFieldAvgTextLength.cs | 8 +- .../Model/TemplateResponseSignerRole.cs | 9 +- .../TemplateUpdateFilesResponseTemplate.cs | 9 +- sdks/java-v1/docs/OAuthApi.md | 2 - sdks/java-v1/docs/OAuthTokenRefreshRequest.md | 2 - ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/java-v1/docs/TemplateResponse.md | 17 +- sdks/java-v1/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/java-v1/docs/TemplateResponseCCRole.md | 2 +- sdks/java-v1/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../java/com/dropbox/sign/api/OAuthApi.java | 4 - .../sign/model/OAuthTokenRefreshRequest.java | 106 +--- ...teCreateEmbeddedDraftResponseTemplate.java | 21 +- .../model/TemplateCreateResponseTemplate.java | 7 +- .../dropbox/sign/model/TemplateResponse.java | 532 +++++++++-------- .../sign/model/TemplateResponseAccount.java | 137 ++--- .../model/TemplateResponseAccountQuota.java | 28 +- .../sign/model/TemplateResponseCCRole.java | 7 +- .../sign/model/TemplateResponseDocument.java | 143 ++--- ...mplateResponseDocumentCustomFieldBase.java | 223 ++++---- ...mplateResponseDocumentCustomFieldText.java | 28 +- .../TemplateResponseDocumentFieldGroup.java | 14 +- ...emplateResponseDocumentFieldGroupRule.java | 14 +- ...TemplateResponseDocumentFormFieldBase.java | 205 +++---- ...lateResponseDocumentFormFieldCheckbox.java | 53 +- ...teResponseDocumentFormFieldDateSigned.java | 53 +- ...lateResponseDocumentFormFieldDropdown.java | 53 +- ...ateResponseDocumentFormFieldHyperlink.java | 85 ++- ...lateResponseDocumentFormFieldInitials.java | 53 +- ...emplateResponseDocumentFormFieldRadio.java | 54 +- ...ateResponseDocumentFormFieldSignature.java | 53 +- ...TemplateResponseDocumentFormFieldText.java | 78 ++- ...mplateResponseDocumentStaticFieldBase.java | 154 ++--- .../TemplateResponseFieldAvgTextLength.java | 14 +- .../model/TemplateResponseSignerRole.java | 7 +- .../TemplateUpdateFilesResponseTemplate.java | 7 +- sdks/java-v2/docs/OAuthApi.md | 2 - sdks/java-v2/docs/OAuthTokenRefreshRequest.md | 2 - ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/java-v2/docs/TemplateResponse.md | 17 +- sdks/java-v2/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/java-v2/docs/TemplateResponseCCRole.md | 2 +- sdks/java-v2/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- .../java/com/dropbox/sign/api/OAuthApi.java | 5 - .../sign/model/OAuthTokenRefreshRequest.java | 106 +--- ...teCreateEmbeddedDraftResponseTemplate.java | 18 +- .../model/TemplateCreateResponseTemplate.java | 6 +- .../dropbox/sign/model/TemplateResponse.java | 533 ++++++++++-------- .../sign/model/TemplateResponseAccount.java | 136 ++--- .../model/TemplateResponseAccountQuota.java | 24 +- .../sign/model/TemplateResponseCCRole.java | 6 +- .../sign/model/TemplateResponseDocument.java | 144 ++--- ...mplateResponseDocumentCustomFieldBase.java | 220 ++++---- ...mplateResponseDocumentCustomFieldText.java | 24 +- .../TemplateResponseDocumentFieldGroup.java | 12 +- ...emplateResponseDocumentFieldGroupRule.java | 12 +- ...TemplateResponseDocumentFormFieldBase.java | 206 +++---- ...lateResponseDocumentFormFieldCheckbox.java | 54 +- ...teResponseDocumentFormFieldDateSigned.java | 54 +- ...lateResponseDocumentFormFieldDropdown.java | 54 +- ...ateResponseDocumentFormFieldHyperlink.java | 78 ++- ...lateResponseDocumentFormFieldInitials.java | 54 +- ...emplateResponseDocumentFormFieldRadio.java | 54 +- ...ateResponseDocumentFormFieldSignature.java | 54 +- ...TemplateResponseDocumentFormFieldText.java | 78 ++- ...mplateResponseDocumentStaticFieldBase.java | 152 ++--- .../TemplateResponseFieldAvgTextLength.java | 12 +- .../model/TemplateResponseSignerRole.java | 6 +- .../TemplateUpdateFilesResponseTemplate.java | 6 +- sdks/node/api/oAuthApi.ts | 22 - sdks/node/dist/api.js | 274 ++++----- .../docs/model/OAuthTokenRefreshRequest.md | 2 - ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../model/TemplateCreateResponseTemplate.md | 2 +- sdks/node/docs/model/TemplateResponse.md | 17 +- .../docs/model/TemplateResponseAccount.md | 10 +- .../model/TemplateResponseAccountQuota.md | 8 +- .../node/docs/model/TemplateResponseCCRole.md | 2 +- .../docs/model/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/model/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- sdks/node/model/oAuthTokenRefreshRequest.ts | 18 - ...lateCreateEmbeddedDraftResponseTemplate.ts | 6 +- .../model/templateCreateResponseTemplate.ts | 2 +- sdks/node/model/templateResponse.ts | 92 +-- sdks/node/model/templateResponseAccount.ts | 28 +- .../model/templateResponseAccountQuota.ts | 8 +- sdks/node/model/templateResponseCCRole.ts | 2 +- sdks/node/model/templateResponseDocument.ts | 28 +- ...templateResponseDocumentCustomFieldBase.ts | 38 +- ...templateResponseDocumentCustomFieldText.ts | 8 +- .../templateResponseDocumentFieldGroup.ts | 4 +- .../templateResponseDocumentFieldGroupRule.ts | 4 +- .../templateResponseDocumentFormFieldBase.ts | 37 +- ...mplateResponseDocumentFormFieldCheckbox.ts | 9 + ...lateResponseDocumentFormFieldDateSigned.ts | 9 + ...mplateResponseDocumentFormFieldDropdown.ts | 9 + ...plateResponseDocumentFormFieldHyperlink.ts | 17 +- ...mplateResponseDocumentFormFieldInitials.ts | 9 + .../templateResponseDocumentFormFieldRadio.ts | 9 + ...plateResponseDocumentFormFieldSignature.ts | 9 + .../templateResponseDocumentFormFieldText.ts | 17 +- ...templateResponseDocumentStaticFieldBase.ts | 28 +- .../templateResponseFieldAvgTextLength.ts | 4 +- sdks/node/model/templateResponseSignerRole.ts | 2 +- .../templateUpdateFilesResponseTemplate.ts | 2 +- .../types/model/oAuthTokenRefreshRequest.d.ts | 2 - ...teCreateEmbeddedDraftResponseTemplate.d.ts | 6 +- .../model/templateCreateResponseTemplate.d.ts | 2 +- sdks/node/types/model/templateResponse.d.ts | 18 +- .../types/model/templateResponseAccount.d.ts | 10 +- .../model/templateResponseAccountQuota.d.ts | 8 +- .../types/model/templateResponseCCRole.d.ts | 2 +- .../types/model/templateResponseDocument.d.ts | 10 +- ...mplateResponseDocumentCustomFieldBase.d.ts | 14 +- ...mplateResponseDocumentCustomFieldText.d.ts | 8 +- .../templateResponseDocumentFieldGroup.d.ts | 4 +- ...emplateResponseDocumentFieldGroupRule.d.ts | 4 +- ...templateResponseDocumentFormFieldBase.d.ts | 17 +- ...lateResponseDocumentFormFieldCheckbox.d.ts | 1 + ...teResponseDocumentFormFieldDateSigned.d.ts | 1 + ...lateResponseDocumentFormFieldDropdown.d.ts | 1 + ...ateResponseDocumentFormFieldHyperlink.d.ts | 9 +- ...lateResponseDocumentFormFieldInitials.d.ts | 1 + ...emplateResponseDocumentFormFieldRadio.d.ts | 1 + ...ateResponseDocumentFormFieldSignature.d.ts | 1 + ...templateResponseDocumentFormFieldText.d.ts | 9 +- ...mplateResponseDocumentStaticFieldBase.d.ts | 16 +- .../templateResponseFieldAvgTextLength.d.ts | 4 +- .../model/templateResponseSignerRole.d.ts | 2 +- .../templateUpdateFilesResponseTemplate.d.ts | 2 +- .../docs/Model/OAuthTokenRefreshRequest.md | 2 - ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../Model/TemplateCreateResponseTemplate.md | 2 +- sdks/php/docs/Model/TemplateResponse.md | 17 +- .../php/docs/Model/TemplateResponseAccount.md | 10 +- .../Model/TemplateResponseAccountQuota.md | 8 +- sdks/php/docs/Model/TemplateResponseCCRole.md | 2 +- .../docs/Model/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../docs/Model/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- sdks/php/src/Api/OAuthApi.php | 24 - .../src/Model/OAuthTokenRefreshRequest.php | 68 --- ...ateCreateEmbeddedDraftResponseTemplate.php | 31 +- .../Model/TemplateCreateResponseTemplate.php | 13 +- sdks/php/src/Model/TemplateResponse.php | 377 +++++++------ .../php/src/Model/TemplateResponseAccount.php | 117 ++-- .../Model/TemplateResponseAccountQuota.php | 40 +- sdks/php/src/Model/TemplateResponseCCRole.php | 13 +- .../src/Model/TemplateResponseDocument.php | 128 +++-- ...emplateResponseDocumentCustomFieldBase.php | 179 +++--- ...emplateResponseDocumentCustomFieldText.php | 36 +- .../TemplateResponseDocumentFieldGroup.php | 22 +- ...TemplateResponseDocumentFieldGroupRule.php | 22 +- .../TemplateResponseDocumentFormFieldBase.php | 173 +++--- ...plateResponseDocumentFormFieldCheckbox.php | 41 ++ ...ateResponseDocumentFormFieldDateSigned.php | 41 ++ ...plateResponseDocumentFormFieldDropdown.php | 41 ++ ...lateResponseDocumentFormFieldHyperlink.php | 77 ++- ...plateResponseDocumentFormFieldInitials.php | 41 ++ ...TemplateResponseDocumentFormFieldRadio.php | 37 ++ ...lateResponseDocumentFormFieldSignature.php | 41 ++ .../TemplateResponseDocumentFormFieldText.php | 77 ++- ...emplateResponseDocumentStaticFieldBase.php | 132 +++-- .../TemplateResponseFieldAvgTextLength.php | 22 +- .../src/Model/TemplateResponseSignerRole.php | 13 +- .../TemplateUpdateFilesResponseTemplate.php | 13 +- sdks/python/docs/OAuthApi.md | 2 - sdks/python/docs/OAuthTokenRefreshRequest.md | 2 - ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/python/docs/TemplateResponse.md | 17 +- sdks/python/docs/TemplateResponseAccount.md | 10 +- .../docs/TemplateResponseAccountQuota.md | 8 +- sdks/python/docs/TemplateResponseCCRole.md | 2 +- sdks/python/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- .../python/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- sdks/python/dropbox_sign/api/o_auth_api.py | 6 - .../models/o_auth_token_refresh_request.py | 21 +- ...create_embedded_draft_response_template.py | 12 +- .../template_create_response_template.py | 6 +- .../dropbox_sign/models/template_response.py | 154 ++--- .../models/template_response_account.py | 31 +- .../models/template_response_account_quota.py | 18 +- .../models/template_response_cc_role.py | 4 +- .../models/template_response_document.py | 33 +- ...ate_response_document_custom_field_base.py | 39 +- ...response_document_custom_field_checkbox.py | 10 +- ...ate_response_document_custom_field_text.py | 33 +- .../template_response_document_field_group.py | 8 +- ...late_response_document_field_group_rule.py | 11 +- ...plate_response_document_form_field_base.py | 41 +- ...e_response_document_form_field_checkbox.py | 10 +- ...esponse_document_form_field_date_signed.py | 12 +- ...e_response_document_form_field_dropdown.py | 10 +- ..._response_document_form_field_hyperlink.py | 27 +- ...e_response_document_form_field_initials.py | 10 +- ...late_response_document_form_field_radio.py | 11 +- ..._response_document_form_field_signature.py | 10 +- ...plate_response_document_form_field_text.py | 31 +- ...ate_response_document_static_field_base.py | 38 +- ...response_document_static_field_checkbox.py | 4 +- ...ponse_document_static_field_date_signed.py | 6 +- ...response_document_static_field_dropdown.py | 4 +- ...esponse_document_static_field_hyperlink.py | 4 +- ...response_document_static_field_initials.py | 4 +- ...te_response_document_static_field_radio.py | 4 +- ...esponse_document_static_field_signature.py | 4 +- ...ate_response_document_static_field_text.py | 4 +- ...template_response_field_avg_text_length.py | 8 +- .../models/template_response_signer_role.py | 2 +- ...template_update_files_response_template.py | 4 +- sdks/ruby/docs/OAuthTokenRefreshRequest.md | 2 - ...lateCreateEmbeddedDraftResponseTemplate.md | 6 +- .../docs/TemplateCreateResponseTemplate.md | 2 +- sdks/ruby/docs/TemplateResponse.md | 17 +- sdks/ruby/docs/TemplateResponseAccount.md | 10 +- .../ruby/docs/TemplateResponseAccountQuota.md | 8 +- sdks/ruby/docs/TemplateResponseCCRole.md | 2 +- sdks/ruby/docs/TemplateResponseDocument.md | 10 +- ...TemplateResponseDocumentCustomFieldBase.md | 14 +- ...TemplateResponseDocumentCustomFieldText.md | 8 +- .../TemplateResponseDocumentFieldGroup.md | 4 +- .../TemplateResponseDocumentFieldGroupRule.md | 4 +- .../TemplateResponseDocumentFormFieldBase.md | 17 +- ...mplateResponseDocumentFormFieldCheckbox.md | 1 + ...lateResponseDocumentFormFieldDateSigned.md | 1 + ...mplateResponseDocumentFormFieldDropdown.md | 1 + ...plateResponseDocumentFormFieldHyperlink.md | 9 +- ...mplateResponseDocumentFormFieldInitials.md | 1 + .../TemplateResponseDocumentFormFieldRadio.md | 1 + ...plateResponseDocumentFormFieldSignature.md | 1 + .../TemplateResponseDocumentFormFieldText.md | 9 +- ...TemplateResponseDocumentStaticFieldBase.md | 16 +- .../TemplateResponseFieldAvgTextLength.md | 4 +- sdks/ruby/docs/TemplateResponseSignerRole.md | 2 +- .../TemplateUpdateFilesResponseTemplate.md | 2 +- sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb | 28 - .../models/o_auth_token_refresh_request.rb | 30 +- ...create_embedded_draft_response_template.rb | 15 + .../template_create_response_template.rb | 5 + .../dropbox-sign/models/template_response.rb | 174 ++++-- .../models/template_response_account.rb | 55 +- .../models/template_response_account_quota.rb | 20 + .../models/template_response_cc_role.rb | 5 + .../models/template_response_document.rb | 58 +- ...ate_response_document_custom_field_base.rb | 73 ++- ...ate_response_document_custom_field_text.rb | 20 + .../template_response_document_field_group.rb | 10 + ...late_response_document_field_group_rule.rb | 10 + ...plate_response_document_form_field_base.rb | 80 ++- ...e_response_document_form_field_checkbox.rb | 20 +- ...esponse_document_form_field_date_signed.rb | 20 +- ...e_response_document_form_field_dropdown.rb | 20 +- ..._response_document_form_field_hyperlink.rb | 40 +- ...e_response_document_form_field_initials.rb | 20 +- ...late_response_document_form_field_radio.rb | 24 +- ..._response_document_form_field_signature.rb | 20 +- ...plate_response_document_form_field_text.rb | 42 +- ...ate_response_document_static_field_base.rb | 62 +- ...template_response_field_avg_text_length.rb | 10 + .../models/template_response_signer_role.rb | 5 + ...template_update_files_response_template.rb | 5 + test_fixtures/TemplateGetResponse.json | 503 +---------------- test_fixtures/TemplateListResponse.json | 39 +- 418 files changed, 6967 insertions(+), 5442 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 5889894a4..1f41d993e 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -2233,23 +2233,6 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: - description: failed_operation - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - 400_example: - $ref: '#/components/examples/Error400ResponseExample' - 401_example: - $ref: '#/components/examples/Error401ResponseExample' - 402_example: - $ref: '#/components/examples/Error402ResponseExample' - 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2333,23 +2316,6 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: - description: failed_operation - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - 400_example: - $ref: '#/components/examples/Error400ResponseExample' - 401_example: - $ref: '#/components/examples/Error401ResponseExample' - 402_example: - $ref: '#/components/examples/Error402ResponseExample' - 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7322,12 +7288,6 @@ components: refresh_token: description: '_t__OAuthTokenRefresh::REFRESH_TOKEN' type: string - client_id: - description: '_t__OAuthTokenRefresh::CLIENT_ID' - type: string - client_secret: - description: '_t__OAuthTokenRefresh::CLIENT_SECRET' - type: string type: object ReportCreateRequest: required: @@ -10674,6 +10634,16 @@ components: x-internal-class: true TemplateResponse: description: '_t__TemplateResponse::DESCRIPTION' + required: + - accounts + - attachments + - can_edit + - documents + - is_creator + - is_locked + - message + - template_id + - title properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10694,15 +10664,12 @@ components: is_creator: description: '_t__TemplateResponse::IS_CREATOR' type: boolean - nullable: true can_edit: description: '_t__TemplateResponse::CAN_EDIT' type: boolean - nullable: true is_locked: description: '_t__TemplateResponse::IS_LOCKED' type: boolean - nullable: true metadata: description: '_t__TemplateResponse::METADATA' type: object @@ -10740,10 +10707,20 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseAccount' - nullable: true + attachments: + description: '_t__SignatureRequestResponseAttachment::DESCRIPTION' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' type: object x-internal-class: true TemplateResponseAccount: + required: + - account_id + - is_locked + - is_paid_hf + - is_paid_hs + - quotas properties: account_id: description: '_t__TemplateResponseAccount::ACCOUNT_ID' @@ -10766,6 +10743,11 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: '_t__TemplateResponseAccountQuota::DESCRIPTION' + required: + - templates_left + - api_signature_requests_left + - documents_left + - sms_verifications_left properties: templates_left: description: '_t__TemplateResponseAccountQuota::TEMPLATES_LEFT' @@ -10782,6 +10764,8 @@ components: type: object x-internal-class: true TemplateResponseCCRole: + required: + - name properties: name: description: '_t__TemplateResponseCCRole::NAME' @@ -10790,6 +10774,10 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: '_t__TemplateCreateEmbeddedDraftResponseTemplate::DESCRIPTION' + required: + - edit_url + - expires_at + - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10810,6 +10798,8 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: '_t__TemplateCreateResponseTemplate::DESCRIPTION' + required: + - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' @@ -10817,6 +10807,12 @@ components: type: object x-internal-class: true TemplateResponseDocument: + required: + - custom_fields + - field_groups + - form_fields + - name + - static_fields properties: name: description: '_t__TemplateResponseDocument::NAME' @@ -10844,13 +10840,19 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - nullable: true type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION' required: + - api_id + - height + - name + - required - type + - width + - x + - 'y' properties: api_id: description: '_t__TemplateResponseDocumentCustomField::API_ID' @@ -10909,6 +10911,10 @@ components: TemplateResponseDocumentCustomFieldText: description: '_t__TemplateResponseDocumentCustomField::DESCRIPTION_EXTENDS' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - @@ -10932,6 +10938,9 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: + required: + - name + - rule properties: name: description: '_t__TemplateResponseDocumentFieldGroup::NAME' @@ -10942,6 +10951,9 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: '_t__TemplateResponseDocumentFieldGroup::RULE' + required: + - groupLabel + - requirement properties: requirement: description: '_t__TemplateResponseDocumentFieldGroupRule::REQUIREMENT' @@ -10954,7 +10966,15 @@ components: TemplateResponseDocumentFormFieldBase: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: '_t__TemplateResponseDocumentFormField::API_ID' @@ -10983,10 +11003,6 @@ components: required: description: '_t__TemplateResponseDocumentFormField::REQUIRED' type: boolean - group: - description: '_t__TemplateResponseDocumentFormField::GROUP' - type: string - nullable: true type: object discriminator: propertyName: type @@ -11003,17 +11019,21 @@ components: x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' + required: + - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: checkbox + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11023,13 +11043,15 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: date_signed + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDropdown: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11039,24 +11061,28 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: dropdown + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' @@ -11073,6 +11099,10 @@ components: fontFamily: description: '_t__TemplateResponseDocumentFormField::FONT_FAMILY' type: string + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldInitials: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11082,13 +11112,15 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: initials + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldRadio: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11099,13 +11131,14 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: radio + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string type: object TemplateResponseDocumentFormFieldSignature: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' @@ -11115,24 +11148,28 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' type: string default: signature + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldText: description: '_t__TemplateResponseDocumentFormField::DESCRIPTION_EXTENDS' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentFormField::TYPE' @@ -11164,11 +11201,23 @@ components: - employer_identification_number - custom_regex nullable: true + group: + description: '_t__TemplateResponseDocumentFormField::GROUP' + type: string + nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: '_t__TemplateResponseDocumentStaticField::DESCRIPTION' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: '_t__TemplateResponseDocumentStaticField::API_ID' @@ -11223,8 +11272,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11239,8 +11286,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11255,8 +11300,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11271,8 +11314,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11287,8 +11328,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11303,8 +11342,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11319,8 +11356,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11335,8 +11370,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: '_t__TemplateResponseDocumentStaticField::TYPE' @@ -11345,6 +11378,9 @@ components: type: object TemplateResponseFieldAvgTextLength: description: '_t__TemplateResponseFieldAvgTextLength::DESCRIPTION' + required: + - num_lines + - num_chars_per_line properties: num_lines: description: '_t__TemplateResponseFieldAvgTextLength::NUM_LINES' @@ -11355,6 +11391,8 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: + required: + - name properties: name: description: '_t__TemplateResponseSignerRole::NAME' @@ -11366,6 +11404,8 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: '_t__TemplateUpdateFilesResponseTemplate::DESCRIPTION' + required: + - template_id properties: template_id: description: '_t__TemplateResponse::TEMPLATE_ID' diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 17a5b7f81..e6a43ab84 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -2239,23 +2239,6 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: - description: failed_operation - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - 400_example: - $ref: '#/components/examples/Error400ResponseExample' - 401_example: - $ref: '#/components/examples/Error401ResponseExample' - 402_example: - $ref: '#/components/examples/Error402ResponseExample' - 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2339,23 +2322,6 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: - description: failed_operation - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - 400_example: - $ref: '#/components/examples/Error400ResponseExample' - 401_example: - $ref: '#/components/examples/Error401ResponseExample' - 402_example: - $ref: '#/components/examples/Error402ResponseExample' - 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7416,12 +7382,6 @@ components: refresh_token: description: 'The token provided when you got the expired access token.' type: string - client_id: - description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' - type: string - client_secret: - description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' - type: string type: object ReportCreateRequest: required: @@ -11290,6 +11250,16 @@ components: x-internal-class: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' + required: + - accounts + - attachments + - can_edit + - documents + - is_creator + - is_locked + - message + - template_id + - title properties: template_id: description: 'The id of the Template.' @@ -11310,18 +11280,15 @@ components: is_creator: description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' type: boolean - nullable: true can_edit: description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' type: boolean - nullable: true is_locked: description: |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. type: boolean - nullable: true metadata: description: 'The metadata attached to the template.' type: object @@ -11359,10 +11326,20 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseAccount' - nullable: true + attachments: + description: 'Signer attachments.' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' type: object x-internal-class: true TemplateResponseAccount: + required: + - account_id + - is_locked + - is_paid_hf + - is_paid_hs + - quotas properties: account_id: description: 'The id of the Account.' @@ -11385,6 +11362,11 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + required: + - templates_left + - api_signature_requests_left + - documents_left + - sms_verifications_left properties: templates_left: description: 'API templates remaining.' @@ -11401,6 +11383,8 @@ components: type: object x-internal-class: true TemplateResponseCCRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -11409,6 +11393,10 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' + required: + - edit_url + - expires_at + - template_id properties: template_id: description: 'The id of the Template.' @@ -11429,6 +11417,8 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' + required: + - template_id properties: template_id: description: 'The id of the Template.' @@ -11436,6 +11426,12 @@ components: type: object x-internal-class: true TemplateResponseDocument: + required: + - custom_fields + - field_groups + - form_fields + - name + - static_fields properties: name: description: 'Name of the associated file.' @@ -11463,13 +11459,19 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - nullable: true type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required - type + - width + - x + - 'y' properties: api_id: description: 'The unique ID for this field.' @@ -11532,6 +11534,10 @@ components: TemplateResponseDocumentCustomFieldText: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - @@ -11559,6 +11565,9 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: + required: + - name + - rule properties: name: description: 'The name of the form field group.' @@ -11569,6 +11578,9 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' + required: + - groupLabel + - requirement properties: requirement: description: |- @@ -11586,7 +11598,15 @@ components: TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the form field.' @@ -11615,10 +11635,6 @@ components: required: description: 'Boolean showing whether or not this field is required.' type: boolean - group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' - type: string - nullable: true type: object discriminator: propertyName: type @@ -11635,12 +11651,12 @@ components: x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + required: + - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11656,6 +11672,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: checkbox + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11665,8 +11685,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11682,6 +11700,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: date_signed + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDropdown: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11691,8 +11713,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11708,17 +11728,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: dropdown + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11745,6 +11771,10 @@ components: fontFamily: description: 'Font family used in this form field''s text.' type: string + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldInitials: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11754,8 +11784,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11771,6 +11799,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: initials + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldRadio: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11781,8 +11813,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11798,6 +11828,9 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: radio + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string type: object TemplateResponseDocumentFormFieldSignature: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11807,8 +11840,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11824,17 +11855,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: signature + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11876,11 +11913,23 @@ components: - employer_identification_number - custom_regex nullable: true + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the static field.' @@ -11935,8 +11984,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11961,8 +12008,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11987,8 +12032,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12013,8 +12056,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12039,8 +12080,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12065,8 +12104,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12091,8 +12128,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12117,8 +12152,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12137,6 +12170,9 @@ components: type: object TemplateResponseFieldAvgTextLength: description: 'Average text length in this field.' + required: + - num_lines + - num_chars_per_line properties: num_lines: description: 'Number of lines.' @@ -12147,6 +12183,8 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -12158,6 +12196,8 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' + required: + - template_id properties: template_id: description: 'The id of the Template.' diff --git a/openapi.yaml b/openapi.yaml index 4b14bfca4..3a2bb2530 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2239,23 +2239,6 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: - description: failed_operation - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - 400_example: - $ref: '#/components/examples/Error400ResponseExample' - 401_example: - $ref: '#/components/examples/Error401ResponseExample' - 402_example: - $ref: '#/components/examples/Error402ResponseExample' - 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2339,23 +2322,6 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: - description: failed_operation - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - examples: - 400_example: - $ref: '#/components/examples/Error400ResponseExample' - 401_example: - $ref: '#/components/examples/Error401ResponseExample' - 402_example: - $ref: '#/components/examples/Error402ResponseExample' - 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7416,12 +7382,6 @@ components: refresh_token: description: 'The token provided when you got the expired access token.' type: string - client_id: - description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' - type: string - client_secret: - description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' - type: string type: object ReportCreateRequest: required: @@ -11268,6 +11228,16 @@ components: x-internal-class: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' + required: + - accounts + - attachments + - can_edit + - documents + - is_creator + - is_locked + - message + - template_id + - title properties: template_id: description: 'The id of the Template.' @@ -11288,18 +11258,15 @@ components: is_creator: description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' type: boolean - nullable: true can_edit: description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' type: boolean - nullable: true is_locked: description: |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. type: boolean - nullable: true metadata: description: 'The metadata attached to the template.' type: object @@ -11337,10 +11304,20 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseAccount' - nullable: true + attachments: + description: 'Signer attachments.' + type: array + items: + $ref: '#/components/schemas/SignatureRequestResponseAttachment' type: object x-internal-class: true TemplateResponseAccount: + required: + - account_id + - is_locked + - is_paid_hf + - is_paid_hs + - quotas properties: account_id: description: 'The id of the Account.' @@ -11363,6 +11340,11 @@ components: x-internal-class: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' + required: + - templates_left + - api_signature_requests_left + - documents_left + - sms_verifications_left properties: templates_left: description: 'API templates remaining.' @@ -11379,6 +11361,8 @@ components: type: object x-internal-class: true TemplateResponseCCRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -11387,6 +11371,10 @@ components: x-internal-class: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' + required: + - edit_url + - expires_at + - template_id properties: template_id: description: 'The id of the Template.' @@ -11407,6 +11395,8 @@ components: x-internal-class: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' + required: + - template_id properties: template_id: description: 'The id of the Template.' @@ -11414,6 +11404,12 @@ components: type: object x-internal-class: true TemplateResponseDocument: + required: + - custom_fields + - field_groups + - form_fields + - name + - static_fields properties: name: description: 'Name of the associated file.' @@ -11441,13 +11437,19 @@ components: type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - nullable: true type: object x-internal-class: true TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required - type + - width + - x + - 'y' properties: api_id: description: 'The unique ID for this field.' @@ -11510,6 +11512,10 @@ components: TemplateResponseDocumentCustomFieldText: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - @@ -11537,6 +11543,9 @@ components: type: string type: object TemplateResponseDocumentFieldGroup: + required: + - name + - rule properties: name: description: 'The name of the form field group.' @@ -11547,6 +11556,9 @@ components: x-internal-class: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' + required: + - groupLabel + - requirement properties: requirement: description: |- @@ -11564,7 +11576,15 @@ components: TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the form field.' @@ -11593,10 +11613,6 @@ components: required: description: 'Boolean showing whether or not this field is required.' type: boolean - group: - description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' - type: string - nullable: true type: object discriminator: propertyName: type @@ -11613,12 +11629,12 @@ components: x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' + required: + - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11634,6 +11650,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: checkbox + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDateSigned: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11643,8 +11663,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11660,6 +11678,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: date_signed + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldDropdown: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11669,8 +11691,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11686,17 +11706,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: dropdown + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11723,6 +11749,10 @@ components: fontFamily: description: 'Font family used in this form field''s text.' type: string + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldInitials: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11732,8 +11762,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11749,6 +11777,10 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: initials + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldRadio: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11759,8 +11791,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11776,6 +11806,9 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: radio + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string type: object TemplateResponseDocumentFormFieldSignature: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' @@ -11785,8 +11818,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11802,17 +11833,23 @@ components: * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: signature + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: + - avg_text_length + - fontFamily + - isMultiline + - originalFontSize - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - - required: - - type properties: type: description: |- @@ -11854,11 +11891,23 @@ components: - employer_identification_number - custom_regex nullable: true + group: + description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' + type: string + nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' required: + - api_id + - height + - name + - required + - signer - type + - width + - x + - 'y' properties: api_id: description: 'A unique id for the static field.' @@ -11913,8 +11962,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11939,8 +11986,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11965,8 +12010,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -11991,8 +12034,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12017,8 +12058,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12043,8 +12082,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12069,8 +12106,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12095,8 +12130,6 @@ components: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - - required: - - type properties: type: description: |- @@ -12115,6 +12148,9 @@ components: type: object TemplateResponseFieldAvgTextLength: description: 'Average text length in this field.' + required: + - num_lines + - num_chars_per_line properties: num_lines: description: 'Number of lines.' @@ -12125,6 +12161,8 @@ components: type: object x-internal-class: true TemplateResponseSignerRole: + required: + - name properties: name: description: 'The name of the Role.' @@ -12136,6 +12174,8 @@ components: x-internal-class: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' + required: + - template_id properties: template_id: description: 'The id of the Template.' diff --git a/sdks/dotnet/docs/OAuthApi.md b/sdks/dotnet/docs/OAuthApi.md index c80ee2758..5af912344 100644 --- a/sdks/dotnet/docs/OAuthApi.md +++ b/sdks/dotnet/docs/OAuthApi.md @@ -99,7 +99,6 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -| **4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -192,7 +191,6 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -| **4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/OAuthTokenRefreshRequest.md b/sdks/dotnet/docs/OAuthTokenRefreshRequest.md index 5e33e77d9..c9866d3bf 100644 --- a/sdks/dotnet/docs/OAuthTokenRefreshRequest.md +++ b/sdks/dotnet/docs/OAuthTokenRefreshRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | **ClientId** | **string** | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [optional] **ClientSecret** | **string** | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [optional] +**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index d23893dd3..14e94249e 100644 --- a/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **EditUrl** | **string** | Link to edit the template. | [optional] **ExpiresAt** | **int** | When the link expires. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | The id of the Template. | **EditUrl** | **string** | Link to edit the template. | **ExpiresAt** | **int** | When the link expires. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [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/TemplateCreateResponseTemplate.md b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md index 85941fc4e..e8b10cc5e 100644 --- a/sdks/dotnet/docs/TemplateCreateResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateCreateResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] +**TemplateId** | **string** | The id of the Template. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponse.md b/sdks/dotnet/docs/TemplateResponse.md index ce17e3777..22138f9c9 100644 --- a/sdks/dotnet/docs/TemplateResponse.md +++ b/sdks/dotnet/docs/TemplateResponse.md @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | [optional] **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **IsCreator** | **bool?** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | [optional] **CanEdit** | **bool?** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | [optional] **IsLocked** | **bool?** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | [optional] +**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] [[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/TemplateResponseAccount.md b/sdks/dotnet/docs/TemplateResponseAccount.md index b69b4ebaa..297e5209a 100644 --- a/sdks/dotnet/docs/TemplateResponseAccount.md +++ b/sdks/dotnet/docs/TemplateResponseAccount.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AccountId** | **string** | The id of the Account. | [optional] **EmailAddress** | **string** | The email address associated with the Account. | [optional] **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | [optional] **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | [optional] **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | [optional] **Quotas** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | [optional] +**AccountId** | **string** | The id of the Account. | **IsLocked** | **bool** | Returns `true` if the user has been locked out of their account by a team admin. | **IsPaidHs** | **bool** | Returns `true` if the user has a paid Dropbox Sign account. | **IsPaidHf** | **bool** | Returns `true` if the user has a paid HelloFax account. | **Quotas** | [**TemplateResponseAccountQuota**](TemplateResponseAccountQuota.md) | | **EmailAddress** | **string** | The email address associated with the Account. | [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/TemplateResponseAccountQuota.md b/sdks/dotnet/docs/TemplateResponseAccountQuota.md index 5051dc54f..9b51ccf96 100644 --- a/sdks/dotnet/docs/TemplateResponseAccountQuota.md +++ b/sdks/dotnet/docs/TemplateResponseAccountQuota.md @@ -5,7 +5,7 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplatesLeft** | **int** | API templates remaining. | [optional] **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | [optional] **DocumentsLeft** | **int** | Signature requests remaining. | [optional] **SmsVerificationsLeft** | **int** | SMS verifications remaining. | [optional] +**TemplatesLeft** | **int** | API templates remaining. | **ApiSignatureRequestsLeft** | **int** | API signature requests remaining. | **DocumentsLeft** | **int** | Signature requests remaining. | **SmsVerificationsLeft** | **int** | SMS verifications remaining. | [[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/TemplateResponseCCRole.md b/sdks/dotnet/docs/TemplateResponseCCRole.md index 1e8067443..fbb67b662 100644 --- a/sdks/dotnet/docs/TemplateResponseCCRole.md +++ b/sdks/dotnet/docs/TemplateResponseCCRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | [optional] +**Name** | **string** | The name of the Role. | [[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/TemplateResponseDocument.md b/sdks/dotnet/docs/TemplateResponseDocument.md index 6847d7b3c..2d475d964 100644 --- a/sdks/dotnet/docs/TemplateResponseDocument.md +++ b/sdks/dotnet/docs/TemplateResponseDocument.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | Name of the associated file. | [optional] **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [optional] **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | [optional] **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional] **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | [optional] +**Name** | **string** | Name of the associated file. | **FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | **FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | **StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | **Index** | **int** | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | [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/TemplateResponseDocumentCustomFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md index 9f349a7ab..11b988b67 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldBase.md @@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | The unique ID for this field. | [optional] **Name** | **string** | The name of the Custom Field. | [optional] **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**ApiId** | **string** | The unique ID for this field. | **Name** | **string** | The name of the Custom Field. | **Type** | **string** | | **X** | **int** | The horizontal offset in pixels for this form field. | **Y** | **int** | The vertical offset in pixels for this form field. | **Width** | **int** | The width in pixels of this form field. | **Height** | **int** | The height in pixels of this form field. | **Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [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/TemplateResponseDocumentCustomFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md index 11a948265..83b4c54aa 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldCheckbox.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**Name** | **string** | The name of the Custom Field. | [optional] +**ApiId** | **string** | The unique ID for this field. | +**Name** | **string** | The name of the Custom Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "checkbox"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md index 8db16365b..4e2fb5a19 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentCustomFieldText.md @@ -5,16 +5,16 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | The unique ID for this field. | [optional] -**Name** | **string** | The name of the Custom Field. | [optional] +**ApiId** | **string** | The unique ID for this field. | +**Name** | **string** | The name of the Custom Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Signer** | **string** | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] -**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] +**Type** | **string** | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md index 0dfac711c..8d3113005 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroup.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the form field group. | [optional] **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | [optional] +**Name** | **string** | The name of the form field group. | **Rule** | [**TemplateResponseDocumentFieldGroupRule**](TemplateResponseDocumentFieldGroupRule.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md index 44dd2eb4a..bf5970a2d 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFieldGroupRule.md @@ -5,7 +5,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Requirement** | **string** | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | [optional] **GroupLabel** | **string** | Name of the group | [optional] +**Requirement** | **string** | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | **GroupLabel** | **string** | Name of the group | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md index 0e941c7ec..3d29f4f62 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldBase.md @@ -5,7 +5,7 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | A unique id for the form field. | [optional] **Name** | **string** | The name of the form field. | [optional] **Signer** | **string** | The signer of the Form Field. | [optional] **X** | **int** | The horizontal offset in pixels for this form field. | [optional] **Y** | **int** | The vertical offset in pixels for this form field. | [optional] **Width** | **int** | The width in pixels of this form field. | [optional] **Height** | **int** | The height in pixels of this form field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] +**ApiId** | **string** | A unique id for the form field. | **Name** | **string** | The name of the form field. | **Type** | **string** | | **Signer** | **string** | The signer of the Form Field. | **X** | **int** | The horizontal offset in pixels for this form field. | **Y** | **int** | The vertical offset in pixels for this form field. | **Width** | **int** | The width in pixels of this form field. | **Height** | **int** | The height in pixels of this form field. | **Required** | **bool** | Boolean showing whether or not this field is required. | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md index 45636fa5a..add6e9a18 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "checkbox"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md index 6bf5b02b3..0c08c5ab2 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "date_signed"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md index fa94587f3..cde089bc9 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "dropdown"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md index c5dc34e1f..481e7f478 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "hyperlink"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md index ada79ecb1..86905a63f 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldInitials.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "initials"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md index abc332ce9..217c5357c 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldRadio.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "radio"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md index 429769c02..08452c6cb 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldSignature.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "signature"]**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentFormFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md index 9bcc4780e..030296903 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentFormFieldText.md @@ -5,16 +5,15 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the form field. | [optional] -**Name** | **string** | The name of the form field. | [optional] -**Signer** | **string** | The signer of the Form Field. | [optional] -**X** | **int** | The horizontal offset in pixels for this form field. | [optional] -**Y** | **int** | The vertical offset in pixels for this form field. | [optional] -**Width** | **int** | The width in pixels of this form field. | [optional] -**Height** | **int** | The height in pixels of this form field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] -**Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [optional] -**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | [optional] **IsMultiline** | **bool** | Whether this form field is multiline text. | [optional] **OriginalFontSize** | **int** | Original font size used in this form field's text. | [optional] **FontFamily** | **string** | Font family used in this form field's text. | [optional] **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] +**ApiId** | **string** | A unique id for the form field. | +**Name** | **string** | The name of the form field. | +**Signer** | **string** | The signer of the Form Field. | +**X** | **int** | The horizontal offset in pixels for this form field. | +**Y** | **int** | The vertical offset in pixels for this form field. | +**Width** | **int** | The width in pixels of this form field. | +**Height** | **int** | The height in pixels of this form field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | +**Type** | **string** | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to "text"]**AvgTextLength** | [**TemplateResponseFieldAvgTextLength**](TemplateResponseFieldAvgTextLength.md) | | **IsMultiline** | **bool** | Whether this form field is multiline text. | **OriginalFontSize** | **int** | Original font size used in this form field's text. | **FontFamily** | **string** | Font family used in this form field's text. | **ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | [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/TemplateResponseDocumentStaticFieldBase.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md index b147460c8..368bc5d06 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldBase.md @@ -5,7 +5,7 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **string** | | **ApiId** | **string** | A unique id for the static field. | [optional] **Name** | **string** | The name of the static field. | [optional] **Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"]**X** | **int** | The horizontal offset in pixels for this static field. | [optional] **Y** | **int** | The vertical offset in pixels for this static field. | [optional] **Width** | **int** | The width in pixels of this static field. | [optional] **Height** | **int** | The height in pixels of this static field. | [optional] **Required** | **bool** | Boolean showing whether or not this field is required. | [optional] **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] +**ApiId** | **string** | A unique id for the static field. | **Name** | **string** | The name of the static field. | **Type** | **string** | | **Signer** | **string** | The signer of the Static Field. | [default to "me_now"]**X** | **int** | The horizontal offset in pixels for this static field. | **Y** | **int** | The vertical offset in pixels for this static field. | **Width** | **int** | The width in pixels of this static field. | **Height** | **int** | The height in pixels of this static field. | **Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [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/TemplateResponseDocumentStaticFieldCheckbox.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md index cfa9ccb8c..b70eab4c5 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldCheckbox.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "checkbox"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md index bae7b8ab4..935ac5748 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDateSigned.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "date_signed"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md index 7815923f9..327d1ccb1 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldDropdown.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "dropdown"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md index 81b419793..f2a3de8a4 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldHyperlink.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "hyperlink"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md index a9dae476b..0cc875be7 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldInitials.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "initials"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md index a13dc60d2..e73fa66a8 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldRadio.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "radio"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md index 7d2481d97..6900f646f 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldSignature.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "signature"] diff --git a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md index b44f3f3e4..8ec627f04 100644 --- a/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md +++ b/sdks/dotnet/docs/TemplateResponseDocumentStaticFieldText.md @@ -5,14 +5,14 @@ This class extends `TemplateResponseDocumentStaticFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApiId** | **string** | A unique id for the static field. | [optional] -**Name** | **string** | The name of the static field. | [optional] -**Signer** | **string** | The signer of the Static Field. | [optional] [default to "me_now"] -**X** | **int** | The horizontal offset in pixels for this static field. | [optional] -**Y** | **int** | The vertical offset in pixels for this static field. | [optional] -**Width** | **int** | The width in pixels of this static field. | [optional] -**Height** | **int** | The height in pixels of this static field. | [optional] -**Required** | **bool** | Boolean showing whether or not this field is required. | [optional] +**ApiId** | **string** | A unique id for the static field. | +**Name** | **string** | The name of the static field. | +**Signer** | **string** | The signer of the Static Field. | [default to "me_now"] +**X** | **int** | The horizontal offset in pixels for this static field. | +**Y** | **int** | The vertical offset in pixels for this static field. | +**Width** | **int** | The width in pixels of this static field. | +**Height** | **int** | The height in pixels of this static field. | +**Required** | **bool** | Boolean showing whether or not this field is required. | **Group** | **string** | The name of the group this field is in. If this field is not a group, this defaults to `null`. | [optional] **Type** | **string** | The type of this static field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentStaticFieldText`
* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`
* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to "text"] diff --git a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md index a2773f068..58559eab7 100644 --- a/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/dotnet/docs/TemplateResponseFieldAvgTextLength.md @@ -5,7 +5,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**NumLines** | **int** | Number of lines. | [optional] **NumCharsPerLine** | **int** | Number of characters per line. | [optional] +**NumLines** | **int** | Number of lines. | **NumCharsPerLine** | **int** | Number of characters per line. | [[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/TemplateResponseSignerRole.md b/sdks/dotnet/docs/TemplateResponseSignerRole.md index ddead2a48..8a1fe3d5e 100644 --- a/sdks/dotnet/docs/TemplateResponseSignerRole.md +++ b/sdks/dotnet/docs/TemplateResponseSignerRole.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Name** | **string** | The name of the Role. | [optional] **Order** | **int** | If signer order is assigned this is the 0-based index for this role. | [optional] +**Name** | **string** | The name of the Role. | **Order** | **int** | If signer order is assigned this is the 0-based index for this role. | [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/TemplateUpdateFilesResponseTemplate.md b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md index 390961e68..c057d7d3a 100644 --- a/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/dotnet/docs/TemplateUpdateFilesResponseTemplate.md @@ -5,7 +5,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | [optional] **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [optional] +**TemplateId** | **string** | The id of the Template. | **Warnings** | [**List<WarningResponse>**](WarningResponse.md) | A list of warnings. | [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/OAuthTokenRefreshRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs index 934de0d88..dbfb22b5f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs @@ -43,9 +43,7 @@ protected OAuthTokenRefreshRequest() { } /// /// When refreshing an existing token use `refresh_token`. (required) (default to "refresh_token"). /// The token provided when you got the expired access token. (required). - /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.. - /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.. - public OAuthTokenRefreshRequest(string grantType = @"refresh_token", string refreshToken = default(string), string clientId = default(string), string clientSecret = default(string)) + public OAuthTokenRefreshRequest(string grantType = @"refresh_token", string refreshToken = default(string)) { // to ensure "grantType" is required (not null) @@ -60,8 +58,6 @@ protected OAuthTokenRefreshRequest() { } throw new ArgumentNullException("refreshToken is a required property for OAuthTokenRefreshRequest and cannot be null"); } this.RefreshToken = refreshToken; - this.ClientId = clientId; - this.ClientSecret = clientSecret; } /// @@ -94,20 +90,6 @@ public static OAuthTokenRefreshRequest Init(string jsonData) [DataMember(Name = "refresh_token", IsRequired = true, EmitDefaultValue = true)] public string RefreshToken { get; set; } - /// - /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - /// - /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - [DataMember(Name = "client_id", EmitDefaultValue = true)] - public string ClientId { get; set; } - - /// - /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - /// - /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - [DataMember(Name = "client_secret", EmitDefaultValue = true)] - public string ClientSecret { get; set; } - /// /// Returns the string presentation of the object /// @@ -118,8 +100,6 @@ public override string ToString() sb.Append("class OAuthTokenRefreshRequest {\n"); sb.Append(" GrantType: ").Append(GrantType).Append("\n"); sb.Append(" RefreshToken: ").Append(RefreshToken).Append("\n"); - sb.Append(" ClientId: ").Append(ClientId).Append("\n"); - sb.Append(" ClientSecret: ").Append(ClientSecret).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -164,16 +144,6 @@ public bool Equals(OAuthTokenRefreshRequest input) this.RefreshToken == input.RefreshToken || (this.RefreshToken != null && this.RefreshToken.Equals(input.RefreshToken)) - ) && - ( - this.ClientId == input.ClientId || - (this.ClientId != null && - this.ClientId.Equals(input.ClientId)) - ) && - ( - this.ClientSecret == input.ClientSecret || - (this.ClientSecret != null && - this.ClientSecret.Equals(input.ClientSecret)) ); } @@ -194,14 +164,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.RefreshToken.GetHashCode(); } - if (this.ClientId != null) - { - hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); - } - if (this.ClientSecret != null) - { - hashCode = (hashCode * 59) + this.ClientSecret.GetHashCode(); - } return hashCode; } } @@ -232,20 +194,6 @@ public List GetOpenApiTypes() Type = "string", Value = RefreshToken, }); - types.Add(new OpenApiType() - { - Name = "client_id", - Property = "ClientId", - Type = "string", - Value = ClientId, - }); - types.Add(new OpenApiType() - { - Name = "client_secret", - Property = "ClientSecret", - Type = "string", - Value = ClientSecret, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs index fb8ca4762..db713a0e3 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateEmbeddedDraftResponseTemplate.cs @@ -41,14 +41,24 @@ protected TemplateCreateEmbeddedDraftResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. - /// Link to edit the template.. - /// When the link expires.. + /// The id of the Template. (required). + /// Link to edit the template. (required). + /// When the link expires. (required). /// A list of warnings.. public TemplateCreateEmbeddedDraftResponseTemplate(string templateId = default(string), string editUrl = default(string), int expiresAt = default(int), List warnings = default(List)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateCreateEmbeddedDraftResponseTemplate and cannot be null"); + } this.TemplateId = templateId; + // to ensure "editUrl" is required (not null) + if (editUrl == null) + { + throw new ArgumentNullException("editUrl is a required property for TemplateCreateEmbeddedDraftResponseTemplate and cannot be null"); + } this.EditUrl = editUrl; this.ExpiresAt = expiresAt; this.Warnings = warnings; @@ -74,21 +84,21 @@ public static TemplateCreateEmbeddedDraftResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// /// Link to edit the template. /// /// Link to edit the template. - [DataMember(Name = "edit_url", EmitDefaultValue = true)] + [DataMember(Name = "edit_url", IsRequired = true, EmitDefaultValue = true)] public string EditUrl { get; set; } /// /// When the link expires. /// /// When the link expires. - [DataMember(Name = "expires_at", EmitDefaultValue = true)] + [DataMember(Name = "expires_at", IsRequired = true, EmitDefaultValue = true)] public int ExpiresAt { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs index 1c362dd91..1ad97711a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateCreateResponseTemplate.cs @@ -41,10 +41,15 @@ protected TemplateCreateResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. + /// The id of the Template. (required). public TemplateCreateResponseTemplate(string templateId = default(string)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateCreateResponseTemplate and cannot be null"); + } this.TemplateId = templateId; } @@ -68,7 +73,7 @@ public static TemplateCreateResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs index 6ec3587f8..de28dad49 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs @@ -41,39 +41,71 @@ protected TemplateResponse() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. - /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. - /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.. + /// The id of the Template. (required). + /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). + /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). /// Time the template was last updated.. /// `true` if this template was created using an embedded flow, `false` if it was created on our website.. - /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member.. - /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).. - /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.. + /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. (required). + /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). (required). + /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. (required). /// The metadata attached to the template.. /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.. /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.. - /// An array describing each document associated with this Template. Includes form field data for each document.. + /// An array describing each document associated with this Template. Includes form field data for each document. (required). /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. - /// An array of the Accounts that can use this Template.. - public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool? isCreator = default(bool?), bool? canEdit = default(bool?), bool? isLocked = default(bool?), Object metadata = default(Object), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List)) + /// An array of the Accounts that can use this Template. (required). + /// Signer attachments. (required). + public TemplateResponse(string templateId = default(string), string title = default(string), string message = default(string), int updatedAt = default(int), bool? isEmbedded = default(bool?), bool isCreator = default(bool), bool canEdit = default(bool), bool isLocked = default(bool), Object metadata = default(Object), List signerRoles = default(List), List ccRoles = default(List), List documents = default(List), List customFields = default(List), List namedFormFields = default(List), List accounts = default(List), List attachments = default(List)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateResponse and cannot be null"); + } this.TemplateId = templateId; + // to ensure "title" is required (not null) + if (title == null) + { + throw new ArgumentNullException("title is a required property for TemplateResponse and cannot be null"); + } this.Title = title; + // to ensure "message" is required (not null) + if (message == null) + { + throw new ArgumentNullException("message is a required property for TemplateResponse and cannot be null"); + } this.Message = message; - this.UpdatedAt = updatedAt; - this.IsEmbedded = isEmbedded; this.IsCreator = isCreator; this.CanEdit = canEdit; this.IsLocked = isLocked; + // to ensure "documents" is required (not null) + if (documents == null) + { + throw new ArgumentNullException("documents is a required property for TemplateResponse and cannot be null"); + } + this.Documents = documents; + // to ensure "accounts" is required (not null) + if (accounts == null) + { + throw new ArgumentNullException("accounts is a required property for TemplateResponse and cannot be null"); + } + this.Accounts = accounts; + // to ensure "attachments" is required (not null) + if (attachments == null) + { + throw new ArgumentNullException("attachments is a required property for TemplateResponse and cannot be null"); + } + this.Attachments = attachments; + this.UpdatedAt = updatedAt; + this.IsEmbedded = isEmbedded; this.Metadata = metadata; this.SignerRoles = signerRoles; this.CcRoles = ccRoles; - this.Documents = documents; this.CustomFields = customFields; this.NamedFormFields = namedFormFields; - this.Accounts = accounts; } /// @@ -96,57 +128,78 @@ public static TemplateResponse Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. /// /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. - [DataMember(Name = "title", EmitDefaultValue = true)] + [DataMember(Name = "title", IsRequired = true, EmitDefaultValue = true)] public string Title { get; set; } /// /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. /// /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. - [DataMember(Name = "message", EmitDefaultValue = true)] + [DataMember(Name = "message", IsRequired = true, EmitDefaultValue = true)] public string Message { get; set; } - /// - /// Time the template was last updated. - /// - /// Time the template was last updated. - [DataMember(Name = "updated_at", EmitDefaultValue = true)] - public int UpdatedAt { get; set; } - - /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. - /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. - [DataMember(Name = "is_embedded", EmitDefaultValue = true)] - public bool? IsEmbedded { get; set; } - /// /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. /// /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. - [DataMember(Name = "is_creator", EmitDefaultValue = true)] - public bool? IsCreator { get; set; } + [DataMember(Name = "is_creator", IsRequired = true, EmitDefaultValue = true)] + public bool IsCreator { get; set; } /// /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). /// /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). - [DataMember(Name = "can_edit", EmitDefaultValue = true)] - public bool? CanEdit { get; set; } + [DataMember(Name = "can_edit", IsRequired = true, EmitDefaultValue = true)] + public bool CanEdit { get; set; } /// /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. /// /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. - [DataMember(Name = "is_locked", EmitDefaultValue = true)] - public bool? IsLocked { get; set; } + [DataMember(Name = "is_locked", IsRequired = true, EmitDefaultValue = true)] + public bool IsLocked { get; set; } + + /// + /// An array describing each document associated with this Template. Includes form field data for each document. + /// + /// An array describing each document associated with this Template. Includes form field data for each document. + [DataMember(Name = "documents", IsRequired = true, EmitDefaultValue = true)] + public List Documents { get; set; } + + /// + /// An array of the Accounts that can use this Template. + /// + /// An array of the Accounts that can use this Template. + [DataMember(Name = "accounts", IsRequired = true, EmitDefaultValue = true)] + public List Accounts { get; set; } + + /// + /// Signer attachments. + /// + /// Signer attachments. + [DataMember(Name = "attachments", IsRequired = true, EmitDefaultValue = true)] + public List Attachments { get; set; } + + /// + /// Time the template was last updated. + /// + /// Time the template was last updated. + [DataMember(Name = "updated_at", EmitDefaultValue = true)] + public int UpdatedAt { get; set; } + + /// + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. + /// + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. + [DataMember(Name = "is_embedded", EmitDefaultValue = true)] + public bool? IsEmbedded { get; set; } /// /// The metadata attached to the template. @@ -169,13 +222,6 @@ public static TemplateResponse Init(string jsonData) [DataMember(Name = "cc_roles", EmitDefaultValue = true)] public List CcRoles { get; set; } - /// - /// An array describing each document associated with this Template. Includes form field data for each document. - /// - /// An array describing each document associated with this Template. Includes form field data for each document. - [DataMember(Name = "documents", EmitDefaultValue = true)] - public List Documents { get; set; } - /// /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. /// @@ -192,13 +238,6 @@ public static TemplateResponse Init(string jsonData) [Obsolete] public List NamedFormFields { get; set; } - /// - /// An array of the Accounts that can use this Template. - /// - /// An array of the Accounts that can use this Template. - [DataMember(Name = "accounts", EmitDefaultValue = true)] - public List Accounts { get; set; } - /// /// Returns the string presentation of the object /// @@ -210,18 +249,19 @@ public override string ToString() sb.Append(" TemplateId: ").Append(TemplateId).Append("\n"); sb.Append(" Title: ").Append(Title).Append("\n"); sb.Append(" Message: ").Append(Message).Append("\n"); - sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); - sb.Append(" IsEmbedded: ").Append(IsEmbedded).Append("\n"); sb.Append(" IsCreator: ").Append(IsCreator).Append("\n"); sb.Append(" CanEdit: ").Append(CanEdit).Append("\n"); sb.Append(" IsLocked: ").Append(IsLocked).Append("\n"); + sb.Append(" Documents: ").Append(Documents).Append("\n"); + sb.Append(" Accounts: ").Append(Accounts).Append("\n"); + sb.Append(" Attachments: ").Append(Attachments).Append("\n"); + sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); + sb.Append(" IsEmbedded: ").Append(IsEmbedded).Append("\n"); sb.Append(" Metadata: ").Append(Metadata).Append("\n"); sb.Append(" SignerRoles: ").Append(SignerRoles).Append("\n"); sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); - sb.Append(" Documents: ").Append(Documents).Append("\n"); sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); sb.Append(" NamedFormFields: ").Append(NamedFormFields).Append("\n"); - sb.Append(" Accounts: ").Append(Accounts).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -273,28 +313,43 @@ public bool Equals(TemplateResponse input) this.Message.Equals(input.Message)) ) && ( - this.UpdatedAt == input.UpdatedAt || - this.UpdatedAt.Equals(input.UpdatedAt) + this.IsCreator == input.IsCreator || + this.IsCreator.Equals(input.IsCreator) ) && ( - this.IsEmbedded == input.IsEmbedded || - (this.IsEmbedded != null && - this.IsEmbedded.Equals(input.IsEmbedded)) + this.CanEdit == input.CanEdit || + this.CanEdit.Equals(input.CanEdit) ) && ( - this.IsCreator == input.IsCreator || - (this.IsCreator != null && - this.IsCreator.Equals(input.IsCreator)) + this.IsLocked == input.IsLocked || + this.IsLocked.Equals(input.IsLocked) ) && ( - this.CanEdit == input.CanEdit || - (this.CanEdit != null && - this.CanEdit.Equals(input.CanEdit)) + this.Documents == input.Documents || + this.Documents != null && + input.Documents != null && + this.Documents.SequenceEqual(input.Documents) ) && ( - this.IsLocked == input.IsLocked || - (this.IsLocked != null && - this.IsLocked.Equals(input.IsLocked)) + this.Accounts == input.Accounts || + this.Accounts != null && + input.Accounts != null && + this.Accounts.SequenceEqual(input.Accounts) + ) && + ( + this.Attachments == input.Attachments || + this.Attachments != null && + input.Attachments != null && + this.Attachments.SequenceEqual(input.Attachments) + ) && + ( + this.UpdatedAt == input.UpdatedAt || + this.UpdatedAt.Equals(input.UpdatedAt) + ) && + ( + this.IsEmbedded == input.IsEmbedded || + (this.IsEmbedded != null && + this.IsEmbedded.Equals(input.IsEmbedded)) ) && ( this.Metadata == input.Metadata || @@ -313,12 +368,6 @@ public bool Equals(TemplateResponse input) input.CcRoles != null && this.CcRoles.SequenceEqual(input.CcRoles) ) && - ( - this.Documents == input.Documents || - this.Documents != null && - input.Documents != null && - this.Documents.SequenceEqual(input.Documents) - ) && ( this.CustomFields == input.CustomFields || this.CustomFields != null && @@ -330,12 +379,6 @@ public bool Equals(TemplateResponse input) this.NamedFormFields != null && input.NamedFormFields != null && this.NamedFormFields.SequenceEqual(input.NamedFormFields) - ) && - ( - this.Accounts == input.Accounts || - this.Accounts != null && - input.Accounts != null && - this.Accounts.SequenceEqual(input.Accounts) ); } @@ -360,22 +403,25 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Message.GetHashCode(); } - hashCode = (hashCode * 59) + this.UpdatedAt.GetHashCode(); - if (this.IsEmbedded != null) + hashCode = (hashCode * 59) + this.IsCreator.GetHashCode(); + hashCode = (hashCode * 59) + this.CanEdit.GetHashCode(); + hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); + if (this.Documents != null) { - hashCode = (hashCode * 59) + this.IsEmbedded.GetHashCode(); + hashCode = (hashCode * 59) + this.Documents.GetHashCode(); } - if (this.IsCreator != null) + if (this.Accounts != null) { - hashCode = (hashCode * 59) + this.IsCreator.GetHashCode(); + hashCode = (hashCode * 59) + this.Accounts.GetHashCode(); } - if (this.CanEdit != null) + if (this.Attachments != null) { - hashCode = (hashCode * 59) + this.CanEdit.GetHashCode(); + hashCode = (hashCode * 59) + this.Attachments.GetHashCode(); } - if (this.IsLocked != null) + hashCode = (hashCode * 59) + this.UpdatedAt.GetHashCode(); + if (this.IsEmbedded != null) { - hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); + hashCode = (hashCode * 59) + this.IsEmbedded.GetHashCode(); } if (this.Metadata != null) { @@ -389,10 +435,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.CcRoles.GetHashCode(); } - if (this.Documents != null) - { - hashCode = (hashCode * 59) + this.Documents.GetHashCode(); - } if (this.CustomFields != null) { hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); @@ -401,10 +443,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.NamedFormFields.GetHashCode(); } - if (this.Accounts != null) - { - hashCode = (hashCode * 59) + this.Accounts.GetHashCode(); - } return hashCode; } } @@ -443,41 +481,62 @@ public List GetOpenApiTypes() Value = Message, }); types.Add(new OpenApiType() - { - Name = "updated_at", - Property = "UpdatedAt", - Type = "int", - Value = UpdatedAt, - }); - types.Add(new OpenApiType() - { - Name = "is_embedded", - Property = "IsEmbedded", - Type = "bool?", - Value = IsEmbedded, - }); - types.Add(new OpenApiType() { Name = "is_creator", Property = "IsCreator", - Type = "bool?", + Type = "bool", Value = IsCreator, }); types.Add(new OpenApiType() { Name = "can_edit", Property = "CanEdit", - Type = "bool?", + Type = "bool", Value = CanEdit, }); types.Add(new OpenApiType() { Name = "is_locked", Property = "IsLocked", - Type = "bool?", + Type = "bool", Value = IsLocked, }); types.Add(new OpenApiType() + { + Name = "documents", + Property = "Documents", + Type = "List", + Value = Documents, + }); + types.Add(new OpenApiType() + { + Name = "accounts", + Property = "Accounts", + Type = "List", + Value = Accounts, + }); + types.Add(new OpenApiType() + { + Name = "attachments", + Property = "Attachments", + Type = "List", + Value = Attachments, + }); + types.Add(new OpenApiType() + { + Name = "updated_at", + Property = "UpdatedAt", + Type = "int", + Value = UpdatedAt, + }); + types.Add(new OpenApiType() + { + Name = "is_embedded", + Property = "IsEmbedded", + Type = "bool?", + Value = IsEmbedded, + }); + types.Add(new OpenApiType() { Name = "metadata", Property = "Metadata", @@ -499,13 +558,6 @@ public List GetOpenApiTypes() Value = CcRoles, }); types.Add(new OpenApiType() - { - Name = "documents", - Property = "Documents", - Type = "List", - Value = Documents, - }); - types.Add(new OpenApiType() { Name = "custom_fields", Property = "CustomFields", @@ -519,13 +571,6 @@ public List GetOpenApiTypes() Type = "List", Value = NamedFormFields, }); - types.Add(new OpenApiType() - { - Name = "accounts", - Property = "Accounts", - Type = "List", - Value = Accounts, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs index 0a40c5548..ef4030d8f 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccount.cs @@ -41,21 +41,31 @@ protected TemplateResponseAccount() { } /// /// Initializes a new instance of the class. /// - /// The id of the Account.. + /// The id of the Account. (required). /// The email address associated with the Account.. - /// Returns `true` if the user has been locked out of their account by a team admin.. - /// Returns `true` if the user has a paid Dropbox Sign account.. - /// Returns `true` if the user has a paid HelloFax account.. - /// quotas. + /// Returns `true` if the user has been locked out of their account by a team admin. (required). + /// Returns `true` if the user has a paid Dropbox Sign account. (required). + /// Returns `true` if the user has a paid HelloFax account. (required). + /// quotas (required). public TemplateResponseAccount(string accountId = default(string), string emailAddress = default(string), bool isLocked = default(bool), bool isPaidHs = default(bool), bool isPaidHf = default(bool), TemplateResponseAccountQuota quotas = default(TemplateResponseAccountQuota)) { + // to ensure "accountId" is required (not null) + if (accountId == null) + { + throw new ArgumentNullException("accountId is a required property for TemplateResponseAccount and cannot be null"); + } this.AccountId = accountId; - this.EmailAddress = emailAddress; this.IsLocked = isLocked; this.IsPaidHs = isPaidHs; this.IsPaidHf = isPaidHf; + // to ensure "quotas" is required (not null) + if (quotas == null) + { + throw new ArgumentNullException("quotas is a required property for TemplateResponseAccount and cannot be null"); + } this.Quotas = quotas; + this.EmailAddress = emailAddress; } /// @@ -78,43 +88,43 @@ public static TemplateResponseAccount Init(string jsonData) /// The id of the Account. /// /// The id of the Account. - [DataMember(Name = "account_id", EmitDefaultValue = true)] + [DataMember(Name = "account_id", IsRequired = true, EmitDefaultValue = true)] public string AccountId { get; set; } - /// - /// The email address associated with the Account. - /// - /// The email address associated with the Account. - [DataMember(Name = "email_address", EmitDefaultValue = true)] - public string EmailAddress { get; set; } - /// /// Returns `true` if the user has been locked out of their account by a team admin. /// /// Returns `true` if the user has been locked out of their account by a team admin. - [DataMember(Name = "is_locked", EmitDefaultValue = true)] + [DataMember(Name = "is_locked", IsRequired = true, EmitDefaultValue = true)] public bool IsLocked { get; set; } /// /// Returns `true` if the user has a paid Dropbox Sign account. /// /// Returns `true` if the user has a paid Dropbox Sign account. - [DataMember(Name = "is_paid_hs", EmitDefaultValue = true)] + [DataMember(Name = "is_paid_hs", IsRequired = true, EmitDefaultValue = true)] public bool IsPaidHs { get; set; } /// /// Returns `true` if the user has a paid HelloFax account. /// /// Returns `true` if the user has a paid HelloFax account. - [DataMember(Name = "is_paid_hf", EmitDefaultValue = true)] + [DataMember(Name = "is_paid_hf", IsRequired = true, EmitDefaultValue = true)] public bool IsPaidHf { get; set; } /// /// Gets or Sets Quotas /// - [DataMember(Name = "quotas", EmitDefaultValue = true)] + [DataMember(Name = "quotas", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseAccountQuota Quotas { get; set; } + /// + /// The email address associated with the Account. + /// + /// The email address associated with the Account. + [DataMember(Name = "email_address", EmitDefaultValue = true)] + public string EmailAddress { get; set; } + /// /// Returns the string presentation of the object /// @@ -124,11 +134,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseAccount {\n"); sb.Append(" AccountId: ").Append(AccountId).Append("\n"); - sb.Append(" EmailAddress: ").Append(EmailAddress).Append("\n"); sb.Append(" IsLocked: ").Append(IsLocked).Append("\n"); sb.Append(" IsPaidHs: ").Append(IsPaidHs).Append("\n"); sb.Append(" IsPaidHf: ").Append(IsPaidHf).Append("\n"); sb.Append(" Quotas: ").Append(Quotas).Append("\n"); + sb.Append(" EmailAddress: ").Append(EmailAddress).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -169,11 +179,6 @@ public bool Equals(TemplateResponseAccount input) (this.AccountId != null && this.AccountId.Equals(input.AccountId)) ) && - ( - this.EmailAddress == input.EmailAddress || - (this.EmailAddress != null && - this.EmailAddress.Equals(input.EmailAddress)) - ) && ( this.IsLocked == input.IsLocked || this.IsLocked.Equals(input.IsLocked) @@ -190,6 +195,11 @@ public bool Equals(TemplateResponseAccount input) this.Quotas == input.Quotas || (this.Quotas != null && this.Quotas.Equals(input.Quotas)) + ) && + ( + this.EmailAddress == input.EmailAddress || + (this.EmailAddress != null && + this.EmailAddress.Equals(input.EmailAddress)) ); } @@ -206,10 +216,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.AccountId.GetHashCode(); } - if (this.EmailAddress != null) - { - hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); - } hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); hashCode = (hashCode * 59) + this.IsPaidHs.GetHashCode(); hashCode = (hashCode * 59) + this.IsPaidHf.GetHashCode(); @@ -217,6 +223,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Quotas.GetHashCode(); } + if (this.EmailAddress != null) + { + hashCode = (hashCode * 59) + this.EmailAddress.GetHashCode(); + } return hashCode; } } @@ -241,13 +251,6 @@ public List GetOpenApiTypes() Value = AccountId, }); types.Add(new OpenApiType() - { - Name = "email_address", - Property = "EmailAddress", - Type = "string", - Value = EmailAddress, - }); - types.Add(new OpenApiType() { Name = "is_locked", Property = "IsLocked", @@ -275,6 +278,13 @@ public List GetOpenApiTypes() Type = "TemplateResponseAccountQuota", Value = Quotas, }); + types.Add(new OpenApiType() + { + Name = "email_address", + Property = "EmailAddress", + Type = "string", + Value = EmailAddress, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs index 5a67d889c..cc5c7177a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseAccountQuota.cs @@ -41,10 +41,10 @@ protected TemplateResponseAccountQuota() { } /// /// Initializes a new instance of the class. /// - /// API templates remaining.. - /// API signature requests remaining.. - /// Signature requests remaining.. - /// SMS verifications remaining.. + /// API templates remaining. (required). + /// API signature requests remaining. (required). + /// Signature requests remaining. (required). + /// SMS verifications remaining. (required). public TemplateResponseAccountQuota(int templatesLeft = default(int), int apiSignatureRequestsLeft = default(int), int documentsLeft = default(int), int smsVerificationsLeft = default(int)) { @@ -74,28 +74,28 @@ public static TemplateResponseAccountQuota Init(string jsonData) /// API templates remaining. /// /// API templates remaining. - [DataMember(Name = "templates_left", EmitDefaultValue = true)] + [DataMember(Name = "templates_left", IsRequired = true, EmitDefaultValue = true)] public int TemplatesLeft { get; set; } /// /// API signature requests remaining. /// /// API signature requests remaining. - [DataMember(Name = "api_signature_requests_left", EmitDefaultValue = true)] + [DataMember(Name = "api_signature_requests_left", IsRequired = true, EmitDefaultValue = true)] public int ApiSignatureRequestsLeft { get; set; } /// /// Signature requests remaining. /// /// Signature requests remaining. - [DataMember(Name = "documents_left", EmitDefaultValue = true)] + [DataMember(Name = "documents_left", IsRequired = true, EmitDefaultValue = true)] public int DocumentsLeft { get; set; } /// /// SMS verifications remaining. /// /// SMS verifications remaining. - [DataMember(Name = "sms_verifications_left", EmitDefaultValue = true)] + [DataMember(Name = "sms_verifications_left", IsRequired = true, EmitDefaultValue = true)] public int SmsVerificationsLeft { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs index e153a6836..444000308 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseCCRole.cs @@ -41,10 +41,15 @@ protected TemplateResponseCCRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role.. + /// The name of the Role. (required). public TemplateResponseCCRole(string name = default(string)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseCCRole and cannot be null"); + } this.Name = name; } @@ -68,7 +73,7 @@ public static TemplateResponseCCRole Init(string jsonData) /// The name of the Role. /// /// The name of the Role. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs index 461b2f2fa..8a1b856c7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocument.cs @@ -41,21 +41,46 @@ protected TemplateResponseDocument() { } /// /// Initializes a new instance of the class. /// - /// Name of the associated file.. + /// Name of the associated file. (required). /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing).. - /// An array of Form Field Group objects.. - /// An array of Form Field objects containing the name and type of each named field.. - /// An array of Form Field objects containing the name and type of each named field.. - /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.. + /// An array of Form Field Group objects. (required). + /// An array of Form Field objects containing the name and type of each named field. (required). + /// An array of Form Field objects containing the name and type of each named field. (required). + /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. (required). public TemplateResponseDocument(string name = default(string), int index = default(int), List fieldGroups = default(List), List formFields = default(List), List customFields = default(List), List staticFields = default(List)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocument and cannot be null"); + } this.Name = name; - this.Index = index; + // to ensure "fieldGroups" is required (not null) + if (fieldGroups == null) + { + throw new ArgumentNullException("fieldGroups is a required property for TemplateResponseDocument and cannot be null"); + } this.FieldGroups = fieldGroups; + // to ensure "formFields" is required (not null) + if (formFields == null) + { + throw new ArgumentNullException("formFields is a required property for TemplateResponseDocument and cannot be null"); + } this.FormFields = formFields; + // to ensure "customFields" is required (not null) + if (customFields == null) + { + throw new ArgumentNullException("customFields is a required property for TemplateResponseDocument and cannot be null"); + } this.CustomFields = customFields; + // to ensure "staticFields" is required (not null) + if (staticFields == null) + { + throw new ArgumentNullException("staticFields is a required property for TemplateResponseDocument and cannot be null"); + } this.StaticFields = staticFields; + this.Index = index; } /// @@ -78,44 +103,44 @@ public static TemplateResponseDocument Init(string jsonData) /// Name of the associated file. /// /// Name of the associated file. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } - /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - /// - /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - [DataMember(Name = "index", EmitDefaultValue = true)] - public int Index { get; set; } - /// /// An array of Form Field Group objects. /// /// An array of Form Field Group objects. - [DataMember(Name = "field_groups", EmitDefaultValue = true)] + [DataMember(Name = "field_groups", IsRequired = true, EmitDefaultValue = true)] public List FieldGroups { get; set; } /// /// An array of Form Field objects containing the name and type of each named field. /// /// An array of Form Field objects containing the name and type of each named field. - [DataMember(Name = "form_fields", EmitDefaultValue = true)] + [DataMember(Name = "form_fields", IsRequired = true, EmitDefaultValue = true)] public List FormFields { get; set; } /// /// An array of Form Field objects containing the name and type of each named field. /// /// An array of Form Field objects containing the name and type of each named field. - [DataMember(Name = "custom_fields", EmitDefaultValue = true)] + [DataMember(Name = "custom_fields", IsRequired = true, EmitDefaultValue = true)] public List CustomFields { get; set; } /// /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. /// /// An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - [DataMember(Name = "static_fields", EmitDefaultValue = true)] + [DataMember(Name = "static_fields", IsRequired = true, EmitDefaultValue = true)] public List StaticFields { get; set; } + /// + /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + /// + /// Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + [DataMember(Name = "index", EmitDefaultValue = true)] + public int Index { get; set; } + /// /// Returns the string presentation of the object /// @@ -125,11 +150,11 @@ public override string ToString() StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocument {\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Index: ").Append(Index).Append("\n"); sb.Append(" FieldGroups: ").Append(FieldGroups).Append("\n"); sb.Append(" FormFields: ").Append(FormFields).Append("\n"); sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); sb.Append(" StaticFields: ").Append(StaticFields).Append("\n"); + sb.Append(" Index: ").Append(Index).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -170,10 +195,6 @@ public bool Equals(TemplateResponseDocument input) (this.Name != null && this.Name.Equals(input.Name)) ) && - ( - this.Index == input.Index || - this.Index.Equals(input.Index) - ) && ( this.FieldGroups == input.FieldGroups || this.FieldGroups != null && @@ -197,6 +218,10 @@ public bool Equals(TemplateResponseDocument input) this.StaticFields != null && input.StaticFields != null && this.StaticFields.SequenceEqual(input.StaticFields) + ) && + ( + this.Index == input.Index || + this.Index.Equals(input.Index) ); } @@ -213,7 +238,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } - hashCode = (hashCode * 59) + this.Index.GetHashCode(); if (this.FieldGroups != null) { hashCode = (hashCode * 59) + this.FieldGroups.GetHashCode(); @@ -230,6 +254,7 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.StaticFields.GetHashCode(); } + hashCode = (hashCode * 59) + this.Index.GetHashCode(); return hashCode; } } @@ -254,13 +279,6 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() - { - Name = "index", - Property = "Index", - Type = "int", - Value = Index, - }); - types.Add(new OpenApiType() { Name = "field_groups", Property = "FieldGroups", @@ -288,6 +306,13 @@ public List GetOpenApiTypes() Type = "List", Value = StaticFields, }); + types.Add(new OpenApiType() + { + Name = "index", + Property = "Index", + Type = "int", + Value = Index, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs index de66ae6db..2e6953d02 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldBase.cs @@ -45,33 +45,43 @@ protected TemplateResponseDocumentCustomFieldBase() { } /// /// Initializes a new instance of the class. /// - /// The unique ID for this field.. - /// The name of the Custom Field.. + /// The unique ID for this field. (required). + /// The name of the Custom Field. (required). /// type (required). /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { + // to ensure "apiId" is required (not null) + if (apiId == null) + { + throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); + } + this.ApiId = apiId; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); + } + this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentCustomFieldBase and cannot be null"); } this.Type = type; - this.ApiId = apiId; - this.Name = name; - this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; + this.Signer = Convert.ToString(signer); this.Group = group; } @@ -91,73 +101,73 @@ public static TemplateResponseDocumentCustomFieldBase Init(string jsonData) return obj; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// The unique ID for this field. /// /// The unique ID for this field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] + [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the Custom Field. /// /// The name of the Custom Field. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + /// Gets or Sets Type /// - /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - [DataMember(Name = "signer", EmitDefaultValue = true)] - public object Signer - { - get => this._signer; - set => this._signer = Convert.ToString(value); - } + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } - private string _signer; /// /// The horizontal offset in pixels for this form field. /// /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] + [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this form field. /// /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] + [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this form field. /// /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] + [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this form field. /// /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] + [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] + [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] public bool Required { get; set; } + /// + /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + /// + /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + [DataMember(Name = "signer", EmitDefaultValue = true)] + public object Signer + { + get => this._signer; + set => this._signer = Convert.ToString(value); + } + + private string _signer; /// /// The name of the group this field is in. If this field is not a group, this defaults to `null`. /// @@ -173,15 +183,15 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentCustomFieldBase {\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); - sb.Append(" Signer: ").Append(Signer).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); sb.Append(" Width: ").Append(Width).Append("\n"); sb.Append(" Height: ").Append(Height).Append("\n"); sb.Append(" Required: ").Append(Required).Append("\n"); + sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -218,11 +228,6 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) return false; } return - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -234,9 +239,9 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) this.Name.Equals(input.Name)) ) && ( - this.Signer == input.Signer || - (this.Signer != null && - this.Signer.Equals(input.Signer)) + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) ) && ( this.X == input.X || @@ -258,6 +263,11 @@ public bool Equals(TemplateResponseDocumentCustomFieldBase input) this.Required == input.Required || this.Required.Equals(input.Required) ) && + ( + this.Signer == input.Signer || + (this.Signer != null && + this.Signer.Equals(input.Signer)) + ) && ( this.Group == input.Group || (this.Group != null && @@ -274,10 +284,6 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -286,15 +292,19 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } - if (this.Signer != null) + if (this.Type != null) { - hashCode = (hashCode * 59) + this.Signer.GetHashCode(); + hashCode = (hashCode * 59) + this.Type.GetHashCode(); } hashCode = (hashCode * 59) + this.X.GetHashCode(); hashCode = (hashCode * 59) + this.Y.GetHashCode(); hashCode = (hashCode * 59) + this.Width.GetHashCode(); hashCode = (hashCode * 59) + this.Height.GetHashCode(); hashCode = (hashCode * 59) + this.Required.GetHashCode(); + if (this.Signer != null) + { + hashCode = (hashCode * 59) + this.Signer.GetHashCode(); + } if (this.Group != null) { hashCode = (hashCode * 59) + this.Group.GetHashCode(); @@ -326,13 +336,6 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -348,10 +351,10 @@ public List GetOpenApiTypes() }); types.Add(new OpenApiType() { - Name = "signer", - Property = "Signer", + Name = "type", + Property = "Type", Type = "string", - Value = Signer, + Value = Type, }); types.Add(new OpenApiType() { @@ -389,6 +392,13 @@ public List GetOpenApiTypes() Value = Required, }); types.Add(new OpenApiType() + { + Name = "signer", + Property = "Signer", + Type = "string", + Value = Signer, + }); + types.Add(new OpenApiType() { Name = "group", Property = "Group", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs index dde2bef21..7f0e4909d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldCheckbox.cs @@ -42,25 +42,25 @@ protected TemplateResponseDocumentCustomFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "checkbox"). - /// The unique ID for this field.. - /// The name of the Custom Field.. + /// The unique ID for this field. (required). + /// The name of the Custom Field. (required). /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; this.Name = name; - this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; + this.Signer = Convert.ToString(signer); this.Group = group; // to ensure "type" is required (not null) diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs index 1e850816f..d7966950a 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentCustomFieldText.cs @@ -42,29 +42,29 @@ protected TemplateResponseDocumentCustomFieldText() { } /// Initializes a new instance of the class. /// /// The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` (required) (default to "text"). - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// The unique ID for this field.. - /// The name of the Custom Field.. + /// avgTextLength (required). + /// Whether this form field is multiline text. (required). + /// Original font size used in this form field's text. (required). + /// Font family used in this form field's text. (required). + /// The unique ID for this field. (required). + /// The name of the Custom Field. (required). /// The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentCustomFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { this.ApiId = apiId; this.Name = name; - this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; + this.Signer = Convert.ToString(signer); this.Group = group; // to ensure "type" is required (not null) @@ -73,9 +73,19 @@ protected TemplateResponseDocumentCustomFieldText() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); } this.Type = type; + // to ensure "avgTextLength" is required (not null) + if (avgTextLength == null) + { + throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); + } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; + // to ensure "fontFamily" is required (not null) + if (fontFamily == null) + { + throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentCustomFieldText and cannot be null"); + } this.FontFamily = fontFamily; } @@ -105,28 +115,28 @@ public static TemplateResponseDocumentCustomFieldText Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] public string FontFamily { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs index 019491e26..1e27c0f38 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroup.cs @@ -41,12 +41,22 @@ protected TemplateResponseDocumentFieldGroup() { } /// /// Initializes a new instance of the class. /// - /// The name of the form field group.. - /// rule. + /// The name of the form field group. (required). + /// rule (required). public TemplateResponseDocumentFieldGroup(string name = default(string), TemplateResponseDocumentFieldGroupRule rule = default(TemplateResponseDocumentFieldGroupRule)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentFieldGroup and cannot be null"); + } this.Name = name; + // to ensure "rule" is required (not null) + if (rule == null) + { + throw new ArgumentNullException("rule is a required property for TemplateResponseDocumentFieldGroup and cannot be null"); + } this.Rule = rule; } @@ -70,13 +80,13 @@ public static TemplateResponseDocumentFieldGroup Init(string jsonData) /// The name of the form field group. /// /// The name of the form field group. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// /// Gets or Sets Rule /// - [DataMember(Name = "rule", EmitDefaultValue = true)] + [DataMember(Name = "rule", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseDocumentFieldGroupRule Rule { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs index ad19e0e20..8f690dccc 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFieldGroupRule.cs @@ -41,12 +41,22 @@ protected TemplateResponseDocumentFieldGroupRule() { } /// /// Initializes a new instance of the class. /// - /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.. - /// Name of the group. + /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. (required). + /// Name of the group (required). public TemplateResponseDocumentFieldGroupRule(string requirement = default(string), string groupLabel = default(string)) { + // to ensure "requirement" is required (not null) + if (requirement == null) + { + throw new ArgumentNullException("requirement is a required property for TemplateResponseDocumentFieldGroupRule and cannot be null"); + } this.Requirement = requirement; + // to ensure "groupLabel" is required (not null) + if (groupLabel == null) + { + throw new ArgumentNullException("groupLabel is a required property for TemplateResponseDocumentFieldGroupRule and cannot be null"); + } this.GroupLabel = groupLabel; } @@ -70,14 +80,14 @@ public static TemplateResponseDocumentFieldGroupRule Init(string jsonData) /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. /// /// Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. - [DataMember(Name = "requirement", EmitDefaultValue = true)] + [DataMember(Name = "requirement", IsRequired = true, EmitDefaultValue = true)] public string Requirement { get; set; } /// /// Name of the group /// /// Name of the group - [DataMember(Name = "groupLabel", EmitDefaultValue = true)] + [DataMember(Name = "groupLabel", IsRequired = true, EmitDefaultValue = true)] public string GroupLabel { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs index 45f1eefac..4e55daa18 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldBase.cs @@ -51,34 +51,47 @@ protected TemplateResponseDocumentFormFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the form field.. - /// The name of the form field.. + /// A unique id for the form field. (required). + /// The name of the form field. (required). /// type (required). - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldBase(string apiId = default(string), string name = default(string), string type = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { + // to ensure "apiId" is required (not null) + if (apiId == null) + { + throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); + } + this.ApiId = apiId; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); + } + this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); } this.Type = type; - this.ApiId = apiId; - this.Name = name; + // to ensure "signer" is required (not null) + if (signer == null) + { + throw new ArgumentNullException("signer is a required property for TemplateResponseDocumentFormFieldBase and cannot be null"); + } this.Signer = Convert.ToString(signer); this.X = x; this.Y = y; this.Width = width; this.Height = height; this.Required = required; - this.Group = group; } /// @@ -97,31 +110,31 @@ public static TemplateResponseDocumentFormFieldBase Init(string jsonData) return obj; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// A unique id for the form field. /// /// A unique id for the form field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] + [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the form field. /// /// The name of the form field. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } + /// + /// Gets or Sets Type + /// + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } + /// /// The signer of the Form Field. /// /// The signer of the Form Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] + [DataMember(Name = "signer", IsRequired = true, EmitDefaultValue = true)] public object Signer { get => this._signer; @@ -133,44 +146,37 @@ public object Signer /// The horizontal offset in pixels for this form field. /// /// The horizontal offset in pixels for this form field. - [DataMember(Name = "x", EmitDefaultValue = true)] + [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this form field. /// /// The vertical offset in pixels for this form field. - [DataMember(Name = "y", EmitDefaultValue = true)] + [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this form field. /// /// The width in pixels of this form field. - [DataMember(Name = "width", EmitDefaultValue = true)] + [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this form field. /// /// The height in pixels of this form field. - [DataMember(Name = "height", EmitDefaultValue = true)] + [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] + [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] public bool Required { get; set; } - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - /// - /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - [DataMember(Name = "group", EmitDefaultValue = true)] - public string Group { get; set; } - /// /// Returns the string presentation of the object /// @@ -179,16 +185,15 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentFormFieldBase {\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); sb.Append(" Width: ").Append(Width).Append("\n"); sb.Append(" Height: ").Append(Height).Append("\n"); sb.Append(" Required: ").Append(Required).Append("\n"); - sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -224,11 +229,6 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) return false; } return - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -239,6 +239,11 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) (this.Name != null && this.Name.Equals(input.Name)) ) && + ( + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) + ) && ( this.Signer == input.Signer || (this.Signer != null && @@ -263,11 +268,6 @@ public bool Equals(TemplateResponseDocumentFormFieldBase input) ( this.Required == input.Required || this.Required.Equals(input.Required) - ) && - ( - this.Group == input.Group || - (this.Group != null && - this.Group.Equals(input.Group)) ); } @@ -280,10 +280,6 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -292,6 +288,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } + if (this.Type != null) + { + hashCode = (hashCode * 59) + this.Type.GetHashCode(); + } if (this.Signer != null) { hashCode = (hashCode * 59) + this.Signer.GetHashCode(); @@ -301,10 +301,6 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.Width.GetHashCode(); hashCode = (hashCode * 59) + this.Height.GetHashCode(); hashCode = (hashCode * 59) + this.Required.GetHashCode(); - if (this.Group != null) - { - hashCode = (hashCode * 59) + this.Group.GetHashCode(); - } return hashCode; } } @@ -332,13 +328,6 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -353,6 +342,13 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() + { + Name = "type", + Property = "Type", + Type = "string", + Value = Type, + }); + types.Add(new OpenApiType() { Name = "signer", Property = "Signer", @@ -394,13 +390,6 @@ public List GetOpenApiTypes() Type = "bool", Value = Required, }); - types.Add(new OpenApiType() - { - Name = "group", - Property = "Group", - Type = "string", - Value = Group, - }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs index 81107edb4..98508a633 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldCheckbox.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "checkbox"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldCheckbox(string type = @"checkbox", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldCheckbox() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldCheckbox and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldCheckbox Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldCheckbox {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldCheckbox input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs index 617886762..96cba8647 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDateSigned.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "date_signed"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldDateSigned(string type = @"date_signed", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldDateSigned(string type = @"date_signed", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldDateSigned() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldDateSigned and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldDateSigned Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldDateSigned {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldDateSigned input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs index e402f7f74..a100c7984 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldDropdown.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldDropdown() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "dropdown"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldDropdown(string type = @"dropdown", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldDropdown() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldDropdown() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldDropdown and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldDropdown Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldDropdown {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldDropdown input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs index 5f874e63a..7138491b7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldHyperlink.cs @@ -42,20 +42,20 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "hyperlink"). - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. + /// avgTextLength (required). + /// Whether this form field is multiline text. (required). + /// Original font size used in this form field's text. (required). + /// Font family used in this form field's text. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldHyperlink(string type = @"hyperlink", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldHyperlink(string type = @"hyperlink", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -65,7 +65,6 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -73,10 +72,21 @@ protected TemplateResponseDocumentFormFieldHyperlink() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); } this.Type = type; + // to ensure "avgTextLength" is required (not null) + if (avgTextLength == null) + { + throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); + } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; + // to ensure "fontFamily" is required (not null) + if (fontFamily == null) + { + throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentFormFieldHyperlink and cannot be null"); + } this.FontFamily = fontFamily; + this.Group = group; } /// @@ -105,30 +115,37 @@ public static TemplateResponseDocumentFormFieldHyperlink Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] public string FontFamily { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -143,6 +160,7 @@ public override string ToString() sb.Append(" IsMultiline: ").Append(IsMultiline).Append("\n"); sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -200,6 +218,11 @@ public bool Equals(TemplateResponseDocumentFormFieldHyperlink input) this.FontFamily == input.FontFamily || (this.FontFamily != null && this.FontFamily.Equals(input.FontFamily)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -226,6 +249,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -291,6 +318,13 @@ public List GetOpenApiTypes() Type = "string", Value = FontFamily, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs index 3eb9296b0..cff4fe342 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldInitials.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldInitials() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "initials"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldInitials(string type = @"initials", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldInitials(string type = @"initials", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldInitials() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldInitials() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldInitials and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldInitials Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldInitials {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldInitials input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs index 2bf695e4d..0d1eec061 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldRadio.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldRadio() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "radio"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. (required). - public TemplateResponseDocumentFormFieldRadio(string type = @"radio", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldRadio(string type = @"radio", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldRadio() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,12 @@ protected TemplateResponseDocumentFormFieldRadio() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldRadio and cannot be null"); } this.Type = type; + // to ensure "group" is required (not null) + if (group == null) + { + throw new ArgumentNullException("group is a required property for TemplateResponseDocumentFormFieldRadio and cannot be null"); + } + this.Group = group; } /// @@ -94,6 +99,13 @@ public static TemplateResponseDocumentFormFieldRadio Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", IsRequired = true, EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +116,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldRadio {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +156,11 @@ public bool Equals(TemplateResponseDocumentFormFieldRadio input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +177,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +218,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs index 79119e439..f5301dd13 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldSignature.cs @@ -42,16 +42,16 @@ protected TemplateResponseDocumentFormFieldSignature() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "signature"). - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldSignature(string type = @"signature", string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldSignature(string type = @"signature", string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -61,7 +61,6 @@ protected TemplateResponseDocumentFormFieldSignature() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -69,6 +68,7 @@ protected TemplateResponseDocumentFormFieldSignature() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldSignature and cannot be null"); } this.Type = type; + this.Group = group; } /// @@ -94,6 +94,13 @@ public static TemplateResponseDocumentFormFieldSignature Init(string jsonData) [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] public string Type { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -104,6 +111,7 @@ public override string ToString() sb.Append("class TemplateResponseDocumentFormFieldSignature {\n"); sb.Append(" ").Append(base.ToString().Replace("\n", "\n ")).Append("\n"); sb.Append(" Type: ").Append(Type).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -143,6 +151,11 @@ public bool Equals(TemplateResponseDocumentFormFieldSignature input) this.Type == input.Type || (this.Type != null && this.Type.Equals(input.Type)) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -159,6 +172,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Type.GetHashCode(); } + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -196,6 +213,13 @@ public List GetOpenApiTypes() Type = "string", Value = Type, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs index ee0686bcb..0d9bbbe31 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentFormFieldText.cs @@ -117,21 +117,21 @@ protected TemplateResponseDocumentFormFieldText() { } /// Initializes a new instance of the class. /// /// The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` (required) (default to "text"). - /// avgTextLength. - /// Whether this form field is multiline text.. - /// Original font size used in this form field's text.. - /// Font family used in this form field's text.. + /// avgTextLength (required). + /// Whether this form field is multiline text. (required). + /// Original font size used in this form field's text. (required). + /// Font family used in this form field's text. (required). /// Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.. - /// A unique id for the form field.. - /// The name of the form field.. - /// The signer of the Form Field.. - /// The horizontal offset in pixels for this form field.. - /// The vertical offset in pixels for this form field.. - /// The width in pixels of this form field.. - /// The height in pixels of this form field.. - /// Boolean showing whether or not this field is required.. /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.. - public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) + /// A unique id for the form field. (required). + /// The name of the form field. (required). + /// The signer of the Form Field. (required). + /// The horizontal offset in pixels for this form field. (required). + /// The vertical offset in pixels for this form field. (required). + /// The width in pixels of this form field. (required). + /// The height in pixels of this form field. (required). + /// Boolean showing whether or not this field is required. (required). + public TemplateResponseDocumentFormFieldText(string type = @"text", TemplateResponseFieldAvgTextLength avgTextLength = default(TemplateResponseFieldAvgTextLength), bool isMultiline = default(bool), int originalFontSize = default(int), string fontFamily = default(string), ValidationTypeEnum? validationType = default(ValidationTypeEnum?), string group = default(string), string apiId = default(string), string name = default(string), Object signer = null, int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool)) { this.ApiId = apiId; this.Name = name; @@ -141,7 +141,6 @@ protected TemplateResponseDocumentFormFieldText() { } this.Width = width; this.Height = height; this.Required = required; - this.Group = group; // to ensure "type" is required (not null) if (type == null) @@ -149,11 +148,22 @@ protected TemplateResponseDocumentFormFieldText() { } throw new ArgumentNullException("type is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); } this.Type = type; + // to ensure "avgTextLength" is required (not null) + if (avgTextLength == null) + { + throw new ArgumentNullException("avgTextLength is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); + } this.AvgTextLength = avgTextLength; this.IsMultiline = isMultiline; this.OriginalFontSize = originalFontSize; + // to ensure "fontFamily" is required (not null) + if (fontFamily == null) + { + throw new ArgumentNullException("fontFamily is a required property for TemplateResponseDocumentFormFieldText and cannot be null"); + } this.FontFamily = fontFamily; this.ValidationType = validationType; + this.Group = group; } /// @@ -182,30 +192,37 @@ public static TemplateResponseDocumentFormFieldText Init(string jsonData) /// /// Gets or Sets AvgTextLength /// - [DataMember(Name = "avg_text_length", EmitDefaultValue = true)] + [DataMember(Name = "avg_text_length", IsRequired = true, EmitDefaultValue = true)] public TemplateResponseFieldAvgTextLength AvgTextLength { get; set; } /// /// Whether this form field is multiline text. /// /// Whether this form field is multiline text. - [DataMember(Name = "isMultiline", EmitDefaultValue = true)] + [DataMember(Name = "isMultiline", IsRequired = true, EmitDefaultValue = true)] public bool IsMultiline { get; set; } /// /// Original font size used in this form field's text. /// /// Original font size used in this form field's text. - [DataMember(Name = "originalFontSize", EmitDefaultValue = true)] + [DataMember(Name = "originalFontSize", IsRequired = true, EmitDefaultValue = true)] public int OriginalFontSize { get; set; } /// /// Font family used in this form field's text. /// /// Font family used in this form field's text. - [DataMember(Name = "fontFamily", EmitDefaultValue = true)] + [DataMember(Name = "fontFamily", IsRequired = true, EmitDefaultValue = true)] public string FontFamily { get; set; } + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + /// + /// The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + [DataMember(Name = "group", EmitDefaultValue = true)] + public string Group { get; set; } + /// /// Returns the string presentation of the object /// @@ -221,6 +238,7 @@ public override string ToString() sb.Append(" OriginalFontSize: ").Append(OriginalFontSize).Append("\n"); sb.Append(" FontFamily: ").Append(FontFamily).Append("\n"); sb.Append(" ValidationType: ").Append(ValidationType).Append("\n"); + sb.Append(" Group: ").Append(Group).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -282,6 +300,11 @@ public bool Equals(TemplateResponseDocumentFormFieldText input) ( this.ValidationType == input.ValidationType || this.ValidationType.Equals(input.ValidationType) + ) && base.Equals(input) && + ( + this.Group == input.Group || + (this.Group != null && + this.Group.Equals(input.Group)) ); } @@ -309,6 +332,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.FontFamily.GetHashCode(); } hashCode = (hashCode * 59) + this.ValidationType.GetHashCode(); + if (this.Group != null) + { + hashCode = (hashCode * 59) + this.Group.GetHashCode(); + } return hashCode; } } @@ -381,6 +408,13 @@ public List GetOpenApiTypes() Type = "string", Value = ValidationType, }); + types.Add(new OpenApiType() + { + Name = "group", + Property = "Group", + Type = "string", + Value = Group, + }); return types; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs index 69281b328..cac470d89 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldBase.cs @@ -51,29 +51,43 @@ protected TemplateResponseDocumentStaticFieldBase() { } /// /// Initializes a new instance of the class. /// - /// A unique id for the static field.. - /// The name of the static field.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). /// type (required). - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldBase(string apiId = default(string), string name = default(string), string type = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { + // to ensure "apiId" is required (not null) + if (apiId == null) + { + throw new ArgumentNullException("apiId is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); + } + this.ApiId = apiId; + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); + } + this.Name = name; // to ensure "type" is required (not null) if (type == null) { throw new ArgumentNullException("type is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); } this.Type = type; - this.ApiId = apiId; - this.Name = name; - // use default value if no "signer" provided - this.Signer = signer ?? "me_now"; + // to ensure "signer" is required (not null) + if (signer == null) + { + throw new ArgumentNullException("signer is a required property for TemplateResponseDocumentStaticFieldBase and cannot be null"); + } + this.Signer = signer; this.X = x; this.Y = y; this.Width = width; @@ -98,66 +112,66 @@ public static TemplateResponseDocumentStaticFieldBase Init(string jsonData) return obj; } - /// - /// Gets or Sets Type - /// - [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] - public string Type { get; set; } - /// /// A unique id for the static field. /// /// A unique id for the static field. - [DataMember(Name = "api_id", EmitDefaultValue = true)] + [DataMember(Name = "api_id", IsRequired = true, EmitDefaultValue = true)] public string ApiId { get; set; } /// /// The name of the static field. /// /// The name of the static field. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } + /// + /// Gets or Sets Type + /// + [DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)] + public string Type { get; set; } + /// /// The signer of the Static Field. /// /// The signer of the Static Field. - [DataMember(Name = "signer", EmitDefaultValue = true)] + [DataMember(Name = "signer", IsRequired = true, EmitDefaultValue = true)] public string Signer { get; set; } /// /// The horizontal offset in pixels for this static field. /// /// The horizontal offset in pixels for this static field. - [DataMember(Name = "x", EmitDefaultValue = true)] + [DataMember(Name = "x", IsRequired = true, EmitDefaultValue = true)] public int X { get; set; } /// /// The vertical offset in pixels for this static field. /// /// The vertical offset in pixels for this static field. - [DataMember(Name = "y", EmitDefaultValue = true)] + [DataMember(Name = "y", IsRequired = true, EmitDefaultValue = true)] public int Y { get; set; } /// /// The width in pixels of this static field. /// /// The width in pixels of this static field. - [DataMember(Name = "width", EmitDefaultValue = true)] + [DataMember(Name = "width", IsRequired = true, EmitDefaultValue = true)] public int Width { get; set; } /// /// The height in pixels of this static field. /// /// The height in pixels of this static field. - [DataMember(Name = "height", EmitDefaultValue = true)] + [DataMember(Name = "height", IsRequired = true, EmitDefaultValue = true)] public int Height { get; set; } /// /// Boolean showing whether or not this field is required. /// /// Boolean showing whether or not this field is required. - [DataMember(Name = "required", EmitDefaultValue = true)] + [DataMember(Name = "required", IsRequired = true, EmitDefaultValue = true)] public bool Required { get; set; } /// @@ -175,9 +189,9 @@ public override string ToString() { StringBuilder sb = new StringBuilder(); sb.Append("class TemplateResponseDocumentStaticFieldBase {\n"); - sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" ApiId: ").Append(ApiId).Append("\n"); sb.Append(" Name: ").Append(Name).Append("\n"); + sb.Append(" Type: ").Append(Type).Append("\n"); sb.Append(" Signer: ").Append(Signer).Append("\n"); sb.Append(" X: ").Append(X).Append("\n"); sb.Append(" Y: ").Append(Y).Append("\n"); @@ -220,11 +234,6 @@ public bool Equals(TemplateResponseDocumentStaticFieldBase input) return false; } return - ( - this.Type == input.Type || - (this.Type != null && - this.Type.Equals(input.Type)) - ) && ( this.ApiId == input.ApiId || (this.ApiId != null && @@ -235,6 +244,11 @@ public bool Equals(TemplateResponseDocumentStaticFieldBase input) (this.Name != null && this.Name.Equals(input.Name)) ) && + ( + this.Type == input.Type || + (this.Type != null && + this.Type.Equals(input.Type)) + ) && ( this.Signer == input.Signer || (this.Signer != null && @@ -276,10 +290,6 @@ public override int GetHashCode() unchecked // Overflow is fine, just wrap { int hashCode = 41; - if (this.Type != null) - { - hashCode = (hashCode * 59) + this.Type.GetHashCode(); - } if (this.ApiId != null) { hashCode = (hashCode * 59) + this.ApiId.GetHashCode(); @@ -288,6 +298,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.Name.GetHashCode(); } + if (this.Type != null) + { + hashCode = (hashCode * 59) + this.Type.GetHashCode(); + } if (this.Signer != null) { hashCode = (hashCode * 59) + this.Signer.GetHashCode(); @@ -328,13 +342,6 @@ public List GetOpenApiTypes() { var types = new List(); types.Add(new OpenApiType() - { - Name = "type", - Property = "Type", - Type = "string", - Value = Type, - }); - types.Add(new OpenApiType() { Name = "api_id", Property = "ApiId", @@ -349,6 +356,13 @@ public List GetOpenApiTypes() Value = Name, }); types.Add(new OpenApiType() + { + Name = "type", + Property = "Type", + Type = "string", + Value = Type, + }); + types.Add(new OpenApiType() { Name = "signer", Property = "Signer", diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs index 0d5fce147..ecc2a11d8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldCheckbox.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldCheckbox() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "checkbox"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldCheckbox(string type = @"checkbox", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs index 4d30a2038..af09f33ac 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDateSigned.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldDateSigned() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "date_signed"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldDateSigned(string type = @"date_signed", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs index 423e983f4..381e2eed8 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldDropdown.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldDropdown() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "dropdown"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldDropdown(string type = @"dropdown", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs index 78b8bd087..4d3426e92 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldHyperlink.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldHyperlink() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "hyperlink"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldHyperlink(string type = @"hyperlink", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs index cc5526323..0d07e78f2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldInitials.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldInitials() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "initials"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldInitials(string type = @"initials", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs index 24f09b8c1..c25fd9db6 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldRadio.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldRadio() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "radio"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldRadio(string type = @"radio", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs index 0d7ea03a6..f4f5b70e2 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldSignature.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldSignature() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "signature"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldSignature(string type = @"signature", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs index 48c59ea75..ba2930e53 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseDocumentStaticFieldText.cs @@ -42,14 +42,14 @@ protected TemplateResponseDocumentStaticFieldText() { } /// Initializes a new instance of the class. /// /// The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` (required) (default to "text"). - /// A unique id for the static field.. - /// The name of the static field.. - /// The signer of the Static Field. (default to "me_now"). - /// The horizontal offset in pixels for this static field.. - /// The vertical offset in pixels for this static field.. - /// The width in pixels of this static field.. - /// The height in pixels of this static field.. - /// Boolean showing whether or not this field is required.. + /// A unique id for the static field. (required). + /// The name of the static field. (required). + /// The signer of the Static Field. (required) (default to "me_now"). + /// The horizontal offset in pixels for this static field. (required). + /// The vertical offset in pixels for this static field. (required). + /// The width in pixels of this static field. (required). + /// The height in pixels of this static field. (required). + /// Boolean showing whether or not this field is required. (required). /// The name of the group this field is in. If this field is not a group, this defaults to `null`.. public TemplateResponseDocumentStaticFieldText(string type = @"text", string apiId = default(string), string name = default(string), string signer = @"me_now", int x = default(int), int y = default(int), int width = default(int), int height = default(int), bool required = default(bool), string group = default(string)) { diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs index 3d3ae1df2..6ed7b426c 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseFieldAvgTextLength.cs @@ -41,8 +41,8 @@ protected TemplateResponseFieldAvgTextLength() { } /// /// Initializes a new instance of the class. /// - /// Number of lines.. - /// Number of characters per line.. + /// Number of lines. (required). + /// Number of characters per line. (required). public TemplateResponseFieldAvgTextLength(int numLines = default(int), int numCharsPerLine = default(int)) { @@ -70,14 +70,14 @@ public static TemplateResponseFieldAvgTextLength Init(string jsonData) /// Number of lines. /// /// Number of lines. - [DataMember(Name = "num_lines", EmitDefaultValue = true)] + [DataMember(Name = "num_lines", IsRequired = true, EmitDefaultValue = true)] public int NumLines { get; set; } /// /// Number of characters per line. /// /// Number of characters per line. - [DataMember(Name = "num_chars_per_line", EmitDefaultValue = true)] + [DataMember(Name = "num_chars_per_line", IsRequired = true, EmitDefaultValue = true)] public int NumCharsPerLine { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs index db464fd46..f11de6735 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponseSignerRole.cs @@ -41,11 +41,16 @@ protected TemplateResponseSignerRole() { } /// /// Initializes a new instance of the class. /// - /// The name of the Role.. + /// The name of the Role. (required). /// If signer order is assigned this is the 0-based index for this role.. public TemplateResponseSignerRole(string name = default(string), int order = default(int)) { + // to ensure "name" is required (not null) + if (name == null) + { + throw new ArgumentNullException("name is a required property for TemplateResponseSignerRole and cannot be null"); + } this.Name = name; this.Order = order; } @@ -70,7 +75,7 @@ public static TemplateResponseSignerRole Init(string jsonData) /// The name of the Role. /// /// The name of the Role. - [DataMember(Name = "name", EmitDefaultValue = true)] + [DataMember(Name = "name", IsRequired = true, EmitDefaultValue = true)] public string Name { get; set; } /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs index 4a8863338..d82c11047 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateUpdateFilesResponseTemplate.cs @@ -41,11 +41,16 @@ protected TemplateUpdateFilesResponseTemplate() { } /// /// Initializes a new instance of the class. /// - /// The id of the Template.. + /// The id of the Template. (required). /// A list of warnings.. public TemplateUpdateFilesResponseTemplate(string templateId = default(string), List warnings = default(List)) { + // to ensure "templateId" is required (not null) + if (templateId == null) + { + throw new ArgumentNullException("templateId is a required property for TemplateUpdateFilesResponseTemplate and cannot be null"); + } this.TemplateId = templateId; this.Warnings = warnings; } @@ -70,7 +75,7 @@ public static TemplateUpdateFilesResponseTemplate Init(string jsonData) /// The id of the Template. /// /// The id of the Template. - [DataMember(Name = "template_id", EmitDefaultValue = true)] + [DataMember(Name = "template_id", IsRequired = true, EmitDefaultValue = true)] public string TemplateId { get; set; } /// diff --git a/sdks/java-v1/docs/OAuthApi.md b/sdks/java-v1/docs/OAuthApi.md index a2eaa2508..533052ba2 100644 --- a/sdks/java-v1/docs/OAuthApi.md +++ b/sdks/java-v1/docs/OAuthApi.md @@ -77,7 +77,6 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -| **4XX** | failed_operation | - | ## oauthTokenRefresh @@ -145,5 +144,4 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -| **4XX** | failed_operation | - | diff --git a/sdks/java-v1/docs/OAuthTokenRefreshRequest.md b/sdks/java-v1/docs/OAuthTokenRefreshRequest.md index f0ce43061..2b985fa91 100644 --- a/sdks/java-v1/docs/OAuthTokenRefreshRequest.md +++ b/sdks/java-v1/docs/OAuthTokenRefreshRequest.md @@ -10,8 +10,6 @@ |------------ | ------------- | ------------- | -------------| | `grantType`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | | | `refreshToken`*_required_ | ```String``` | The token provided when you got the expired access token. | | -| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | -| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 770cce434..224ec6c71 100644 --- a/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -8,9 +8,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `editUrl` | ```String``` | Link to edit the template. | | -| `expiresAt` | ```Integer``` | When the link expires. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `editUrl`*_required_ | ```String``` | Link to edit the template. | | +| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md index 1dcd4bd79..79801d898 100644 --- a/sdks/java-v1/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateCreateResponseTemplate.md @@ -8,7 +8,7 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | diff --git a/sdks/java-v1/docs/TemplateResponse.md b/sdks/java-v1/docs/TemplateResponse.md index 078685ff1..323e905f6 100644 --- a/sdks/java-v1/docs/TemplateResponse.md +++ b/sdks/java-v1/docs/TemplateResponse.md @@ -8,21 +8,22 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | | `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | | `metadata` | ```Object``` | The metadata attached to the template. | | | `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | | `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | diff --git a/sdks/java-v1/docs/TemplateResponseAccount.md b/sdks/java-v1/docs/TemplateResponseAccount.md index 10c996408..dd8ebce7f 100644 --- a/sdks/java-v1/docs/TemplateResponseAccount.md +++ b/sdks/java-v1/docs/TemplateResponseAccount.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The id of the Account. | | +| `accountId`*_required_ | ```String``` | The id of the Account. | | +| `isLocked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | | `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseAccountQuota.md b/sdks/java-v1/docs/TemplateResponseAccountQuota.md index ad94c2493..72160ca8f 100644 --- a/sdks/java-v1/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v1/docs/TemplateResponseAccountQuota.md @@ -8,10 +8,10 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft`*_required_ | ```Integer``` | API templates remaining. | | +| `apiSignatureRequestsLeft`*_required_ | ```Integer``` | API signature requests remaining. | | +| `documentsLeft`*_required_ | ```Integer``` | Signature requests remaining. | | +| `smsVerificationsLeft`*_required_ | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/java-v1/docs/TemplateResponseCCRole.md b/sdks/java-v1/docs/TemplateResponseCCRole.md index 64069b826..06e61bff4 100644 --- a/sdks/java-v1/docs/TemplateResponseCCRole.md +++ b/sdks/java-v1/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocument.md b/sdks/java-v1/docs/TemplateResponseDocument.md index 65da85d42..cb69a481f 100644 --- a/sdks/java-v1/docs/TemplateResponseDocument.md +++ b/sdks/java-v1/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | Name of the associated file. | | +| `name`*_required_ | ```String``` | Name of the associated file. | | +| `fieldGroups`*_required_ | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields`*_required_ | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields`*_required_ | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields`*_required_ | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md index edd461727..c7c7f8264 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | The unique ID for this field. | | +| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md index ccaf19394..70c991777 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentCustomFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md index 03b5ffbb8..7dd066f54 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroup.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```String``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md index e0f4dcc8a..59d4e5e06 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFieldGroupRule.md @@ -8,8 +8,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel` | ```String``` | Name of the group | | +| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel`*_required_ | ```String``` | Name of the group | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md index 656070ad4..8d8766339 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldBase.md @@ -8,16 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the form field. | | +| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```String``` | The signer of the Form Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md index 83d36e0f1..a7f2cadeb 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md index 5ba66eff9..09b45eec7 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md index b4f2030fc..70e5da455 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md index 0cf89df5e..104029730 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -9,10 +9,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md index 707d67ee2..f1fe1f5b5 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldInitials.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md index b83d96d53..877b842a2 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldRadio.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md index 8be298793..366aaa9b4 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldSignature.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md index 3581d3855..31520bd6f 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentFormFieldText.md @@ -9,11 +9,12 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | | `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md index 4be3cf070..f52329b04 100644 --- a/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v1/docs/TemplateResponseDocumentStaticFieldBase.md @@ -8,15 +8,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the static field. | | +| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```String``` | The signer of the Static Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md index bb66f3057..f0d2106b0 100644 --- a/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v1/docs/TemplateResponseFieldAvgTextLength.md @@ -8,8 +8,8 @@ Average text length in this field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines` | ```Integer``` | Number of lines. | | -| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | +| `numLines`*_required_ | ```Integer``` | Number of lines. | | +| `numCharsPerLine`*_required_ | ```Integer``` | Number of characters per line. | | diff --git a/sdks/java-v1/docs/TemplateResponseSignerRole.md b/sdks/java-v1/docs/TemplateResponseSignerRole.md index 15b48cf17..08458f4e0 100644 --- a/sdks/java-v1/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v1/docs/TemplateResponseSignerRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md index 6289a9953..7acdbb340 100644 --- a/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v1/docs/TemplateUpdateFilesResponseTemplate.md @@ -8,7 +8,7 @@ Contains template id | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java index db4fbb10c..f9e6d08f3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -55,7 +55,6 @@ public void setApiClient(ApiClient apiClient) { * * * - * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenGenerate( @@ -74,7 +73,6 @@ public OAuthTokenResponse oauthTokenGenerate( * * * - * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenGenerateWithHttpInfo( @@ -127,7 +125,6 @@ public ApiResponse oauthTokenGenerateWithHttpInfo( * * * - * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest) @@ -148,7 +145,6 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR * * * - * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenRefreshWithHttpInfo( diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java index 75979827e..6aa0a0552 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java @@ -26,9 +26,7 @@ /** OAuthTokenRefreshRequest */ @JsonPropertyOrder({ OAuthTokenRefreshRequest.JSON_PROPERTY_GRANT_TYPE, - OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN, - OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_ID, - OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_SECRET + OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -41,12 +39,6 @@ public class OAuthTokenRefreshRequest { public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; private String refreshToken; - public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; - private String clientId; - - public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; - private String clientSecret; - public OAuthTokenRefreshRequest() {} /** @@ -111,54 +103,6 @@ public void setRefreshToken(String refreshToken) { this.refreshToken = refreshToken; } - public OAuthTokenRefreshRequest clientId(String clientId) { - this.clientId = clientId; - return this; - } - - /** - * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the - * \"Client Credentials Required\" setting is enabled for token refresh; optional if - * disabled. - * - * @return clientId - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getClientId() { - return clientId; - } - - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { - this.clientId = clientId; - } - - public OAuthTokenRefreshRequest clientSecret(String clientSecret) { - this.clientSecret = clientSecret; - return this; - } - - /** - * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if - * the \"Client Credentials Required\" setting is enabled for token refresh; optional - * if disabled. - * - * @return clientSecret - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getClientSecret() { - return clientSecret; - } - - @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientSecret(String clientSecret) { - this.clientSecret = clientSecret; - } - /** Return true if this OAuthTokenRefreshRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -170,14 +114,12 @@ public boolean equals(Object o) { } OAuthTokenRefreshRequest oauthTokenRefreshRequest = (OAuthTokenRefreshRequest) o; return Objects.equals(this.grantType, oauthTokenRefreshRequest.grantType) - && Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken) - && Objects.equals(this.clientId, oauthTokenRefreshRequest.clientId) - && Objects.equals(this.clientSecret, oauthTokenRefreshRequest.clientSecret); + && Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken); } @Override public int hashCode() { - return Objects.hash(grantType, refreshToken, clientId, clientSecret); + return Objects.hash(grantType, refreshToken); } @Override @@ -186,8 +128,6 @@ public String toString() { sb.append("class OAuthTokenRefreshRequest {\n"); sb.append(" grantType: ").append(toIndentedString(grantType)).append("\n"); sb.append(" refreshToken: ").append(toIndentedString(refreshToken)).append("\n"); - sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); - sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -236,46 +176,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(refreshToken)); } } - if (clientId != null) { - if (isFileTypeOrListOfFiles(clientId)) { - fileTypeFound = true; - } - - if (clientId.getClass().equals(java.io.File.class) - || clientId.getClass().equals(Integer.class) - || clientId.getClass().equals(String.class) - || clientId.getClass().isEnum()) { - map.put("client_id", clientId); - } else if (isListOfFile(clientId)) { - for (int i = 0; i < getListSize(clientId); i++) { - map.put("client_id[" + i + "]", getFromList(clientId, i)); - } - } else { - map.put( - "client_id", - JSON.getDefault().getMapper().writeValueAsString(clientId)); - } - } - if (clientSecret != null) { - if (isFileTypeOrListOfFiles(clientSecret)) { - fileTypeFound = true; - } - - if (clientSecret.getClass().equals(java.io.File.class) - || clientSecret.getClass().equals(Integer.class) - || clientSecret.getClass().equals(String.class) - || clientSecret.getClass().isEnum()) { - map.put("client_secret", clientSecret); - } else if (isListOfFile(clientSecret)) { - for (int i = 0; i < getListSize(clientSecret); i++) { - map.put("client_secret[" + i + "]", getFromList(clientSecret, i)); - } - } else { - map.put( - "client_secret", - JSON.getDefault().getMapper().writeValueAsString(clientSecret)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index 7e2fc0bc4..e82d6aa72 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -82,14 +82,15 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId(String templateId) * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -104,14 +105,15 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl(String editUrl) { * * @return editUrl */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_EDIT_URL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getEditUrl() { return editUrl; } @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEditUrl(String editUrl) { this.editUrl = editUrl; } @@ -126,14 +128,15 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(Integer expiresAt) * * @return expiresAt */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_EXPIRES_AT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getExpiresAt() { return expiresAt; } @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setExpiresAt(Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index 017ed6e40..cd3964ffb 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -61,14 +61,15 @@ public TemplateCreateResponseTemplate templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 3a0e14a2f..5cc3dcde9 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -30,18 +30,19 @@ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, TemplateResponse.JSON_PROPERTY_TITLE, TemplateResponse.JSON_PROPERTY_MESSAGE, - TemplateResponse.JSON_PROPERTY_UPDATED_AT, - TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, + TemplateResponse.JSON_PROPERTY_DOCUMENTS, + TemplateResponse.JSON_PROPERTY_ACCOUNTS, + TemplateResponse.JSON_PROPERTY_ATTACHMENTS, + TemplateResponse.JSON_PROPERTY_UPDATED_AT, + TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_METADATA, TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, TemplateResponse.JSON_PROPERTY_CC_ROLES, - TemplateResponse.JSON_PROPERTY_DOCUMENTS, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, - TemplateResponse.JSON_PROPERTY_ACCOUNTS + TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -57,12 +58,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_MESSAGE = "message"; private String message; - public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; - private Integer updatedAt; - - public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; - private Boolean isEmbedded; - public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; private Boolean isCreator; @@ -72,6 +67,21 @@ public class TemplateResponse { public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; + public static final String JSON_PROPERTY_DOCUMENTS = "documents"; + private List documents = new ArrayList<>(); + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private List accounts = new ArrayList<>(); + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = new ArrayList<>(); + + public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + private Integer updatedAt; + + public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; + private Boolean isEmbedded; + public static final String JSON_PROPERTY_METADATA = "metadata"; private Object metadata; @@ -81,18 +91,12 @@ public class TemplateResponse { public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; private List ccRoles = null; - public static final String JSON_PROPERTY_DOCUMENTS = "documents"; - private List documents = null; - public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated private List customFields = null; public static final String JSON_PROPERTY_NAMED_FORM_FIELDS = "named_form_fields"; @Deprecated private List namedFormFields = null; - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; - public TemplateResponse() {} /** @@ -119,14 +123,15 @@ public TemplateResponse templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -143,14 +148,15 @@ public TemplateResponse title(String title) { * * @return title */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTitle() { return title; } @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTitle(String title) { this.title = title; } @@ -166,63 +172,19 @@ public TemplateResponse message(String message) { * * @return message */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getMessage() { return message; } @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setMessage(String message) { this.message = message; } - public TemplateResponse updatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Time the template was last updated. - * - * @return updatedAt - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Integer getUpdatedAt() { - return updatedAt; - } - - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - } - - public TemplateResponse isEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - return this; - } - - /** - * `true` if this template was created using an embedded flow, `false` if it - * was created on our website. - * - * @return isEmbedded - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getIsEmbedded() { - return isEmbedded; - } - - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - } - public TemplateResponse isCreator(Boolean isCreator) { this.isCreator = isCreator; return this; @@ -234,14 +196,15 @@ public TemplateResponse isCreator(Boolean isCreator) { * * @return isCreator */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_CREATOR) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsCreator() { return isCreator; } @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -257,14 +220,15 @@ public TemplateResponse canEdit(Boolean canEdit) { * * @return canEdit */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CAN_EDIT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getCanEdit() { return canEdit; } @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCanEdit(Boolean canEdit) { this.canEdit = canEdit; } @@ -281,18 +245,158 @@ public TemplateResponse isLocked(Boolean isLocked) { * * @return isLocked */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_LOCKED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsLocked() { return isLocked; } @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } + public TemplateResponse documents(List documents) { + this.documents = documents; + return this; + } + + public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) { + if (this.documents == null) { + this.documents = new ArrayList<>(); + } + this.documents.add(documentsItem); + return this; + } + + /** + * An array describing each document associated with this Template. Includes form field data for + * each document. + * + * @return documents + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DOCUMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getDocuments() { + return documents; + } + + @JsonProperty(JSON_PROPERTY_DOCUMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDocuments(List documents) { + this.documents = documents; + } + + public TemplateResponse accounts(List accounts) { + this.accounts = accounts; + return this; + } + + public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { + if (this.accounts == null) { + this.accounts = new ArrayList<>(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * An array of the Accounts that can use this Template. + * + * @return accounts + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getAccounts() { + return accounts; + } + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAccounts(List accounts) { + this.accounts = accounts; + } + + public TemplateResponse attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * Signer attachments. + * + * @return attachments + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getAttachments() { + return attachments; + } + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + public TemplateResponse updatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + * Time the template was last updated. + * + * @return updatedAt + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getUpdatedAt() { + return updatedAt; + } + + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUpdatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + } + + public TemplateResponse isEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + return this; + } + + /** + * `true` if this template was created using an embedded flow, `false` if it + * was created on our website. + * + * @return isEmbedded + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIsEmbedded() { + return isEmbedded; + } + + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + } + public TemplateResponse metadata(Object metadata) { this.metadata = metadata; return this; @@ -377,37 +481,6 @@ public void setCcRoles(List ccRoles) { this.ccRoles = ccRoles; } - public TemplateResponse documents(List documents) { - this.documents = documents; - return this; - } - - public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) { - if (this.documents == null) { - this.documents = new ArrayList<>(); - } - this.documents.add(documentsItem); - return this; - } - - /** - * An array describing each document associated with this Template. Includes form field data for - * each document. - * - * @return documents - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public List getDocuments() { - return documents; - } - - @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDocuments(List documents) { - this.documents = documents; - } - @Deprecated public TemplateResponse customFields( List customFields) { @@ -484,36 +557,6 @@ public void setNamedFormFields(List named this.namedFormFields = namedFormFields; } - public TemplateResponse accounts(List accounts) { - this.accounts = accounts; - return this; - } - - public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { - if (this.accounts == null) { - this.accounts = new ArrayList<>(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * An array of the Accounts that can use this Template. - * - * @return accounts - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public List getAccounts() { - return accounts; - } - - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccounts(List accounts) { - this.accounts = accounts; - } - /** Return true if this TemplateResponse object is equal to o. */ @Override public boolean equals(Object o) { @@ -527,18 +570,19 @@ public boolean equals(Object o) { return Objects.equals(this.templateId, templateResponse.templateId) && Objects.equals(this.title, templateResponse.title) && Objects.equals(this.message, templateResponse.message) - && Objects.equals(this.updatedAt, templateResponse.updatedAt) - && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) + && Objects.equals(this.documents, templateResponse.documents) + && Objects.equals(this.accounts, templateResponse.accounts) + && Objects.equals(this.attachments, templateResponse.attachments) + && Objects.equals(this.updatedAt, templateResponse.updatedAt) + && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.metadata, templateResponse.metadata) && Objects.equals(this.signerRoles, templateResponse.signerRoles) && Objects.equals(this.ccRoles, templateResponse.ccRoles) - && Objects.equals(this.documents, templateResponse.documents) && Objects.equals(this.customFields, templateResponse.customFields) - && Objects.equals(this.namedFormFields, templateResponse.namedFormFields) - && Objects.equals(this.accounts, templateResponse.accounts); + && Objects.equals(this.namedFormFields, templateResponse.namedFormFields); } @Override @@ -547,18 +591,19 @@ public int hashCode() { templateId, title, message, - updatedAt, - isEmbedded, isCreator, canEdit, isLocked, + documents, + accounts, + attachments, + updatedAt, + isEmbedded, metadata, signerRoles, ccRoles, - documents, customFields, - namedFormFields, - accounts); + namedFormFields); } @Override @@ -568,18 +613,19 @@ public String toString() { sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); - sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); + sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); + sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); - sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); sb.append("}"); return sb.toString(); } @@ -644,46 +690,6 @@ public Map createFormData() throws ApiException { map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); } } - if (updatedAt != null) { - if (isFileTypeOrListOfFiles(updatedAt)) { - fileTypeFound = true; - } - - if (updatedAt.getClass().equals(java.io.File.class) - || updatedAt.getClass().equals(Integer.class) - || updatedAt.getClass().equals(String.class) - || updatedAt.getClass().isEnum()) { - map.put("updated_at", updatedAt); - } else if (isListOfFile(updatedAt)) { - for (int i = 0; i < getListSize(updatedAt); i++) { - map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); - } - } else { - map.put( - "updated_at", - JSON.getDefault().getMapper().writeValueAsString(updatedAt)); - } - } - if (isEmbedded != null) { - if (isFileTypeOrListOfFiles(isEmbedded)) { - fileTypeFound = true; - } - - if (isEmbedded.getClass().equals(java.io.File.class) - || isEmbedded.getClass().equals(Integer.class) - || isEmbedded.getClass().equals(String.class) - || isEmbedded.getClass().isEnum()) { - map.put("is_embedded", isEmbedded); - } else if (isListOfFile(isEmbedded)) { - for (int i = 0; i < getListSize(isEmbedded); i++) { - map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); - } - } else { - map.put( - "is_embedded", - JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); - } - } if (isCreator != null) { if (isFileTypeOrListOfFiles(isCreator)) { fileTypeFound = true; @@ -742,6 +748,104 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(isLocked)); } } + if (documents != null) { + if (isFileTypeOrListOfFiles(documents)) { + fileTypeFound = true; + } + + if (documents.getClass().equals(java.io.File.class) + || documents.getClass().equals(Integer.class) + || documents.getClass().equals(String.class) + || documents.getClass().isEnum()) { + map.put("documents", documents); + } else if (isListOfFile(documents)) { + for (int i = 0; i < getListSize(documents); i++) { + map.put("documents[" + i + "]", getFromList(documents, i)); + } + } else { + map.put( + "documents", + JSON.getDefault().getMapper().writeValueAsString(documents)); + } + } + if (accounts != null) { + if (isFileTypeOrListOfFiles(accounts)) { + fileTypeFound = true; + } + + if (accounts.getClass().equals(java.io.File.class) + || accounts.getClass().equals(Integer.class) + || accounts.getClass().equals(String.class) + || accounts.getClass().isEnum()) { + map.put("accounts", accounts); + } else if (isListOfFile(accounts)) { + for (int i = 0; i < getListSize(accounts); i++) { + map.put("accounts[" + i + "]", getFromList(accounts, i)); + } + } else { + map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) + || attachments.getClass().equals(Integer.class) + || attachments.getClass().equals(String.class) + || attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for (int i = 0; i < getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } else { + map.put( + "attachments", + JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (updatedAt != null) { + if (isFileTypeOrListOfFiles(updatedAt)) { + fileTypeFound = true; + } + + if (updatedAt.getClass().equals(java.io.File.class) + || updatedAt.getClass().equals(Integer.class) + || updatedAt.getClass().equals(String.class) + || updatedAt.getClass().isEnum()) { + map.put("updated_at", updatedAt); + } else if (isListOfFile(updatedAt)) { + for (int i = 0; i < getListSize(updatedAt); i++) { + map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); + } + } else { + map.put( + "updated_at", + JSON.getDefault().getMapper().writeValueAsString(updatedAt)); + } + } + if (isEmbedded != null) { + if (isFileTypeOrListOfFiles(isEmbedded)) { + fileTypeFound = true; + } + + if (isEmbedded.getClass().equals(java.io.File.class) + || isEmbedded.getClass().equals(Integer.class) + || isEmbedded.getClass().equals(String.class) + || isEmbedded.getClass().isEnum()) { + map.put("is_embedded", isEmbedded); + } else if (isListOfFile(isEmbedded)) { + for (int i = 0; i < getListSize(isEmbedded); i++) { + map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); + } + } else { + map.put( + "is_embedded", + JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); + } + } if (metadata != null) { if (isFileTypeOrListOfFiles(metadata)) { fileTypeFound = true; @@ -798,26 +902,6 @@ public Map createFormData() throws ApiException { map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); } } - if (documents != null) { - if (isFileTypeOrListOfFiles(documents)) { - fileTypeFound = true; - } - - if (documents.getClass().equals(java.io.File.class) - || documents.getClass().equals(Integer.class) - || documents.getClass().equals(String.class) - || documents.getClass().isEnum()) { - map.put("documents", documents); - } else if (isListOfFile(documents)) { - for (int i = 0; i < getListSize(documents); i++) { - map.put("documents[" + i + "]", getFromList(documents, i)); - } - } else { - map.put( - "documents", - JSON.getDefault().getMapper().writeValueAsString(documents)); - } - } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; @@ -858,24 +942,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(namedFormFields)); } } - if (accounts != null) { - if (isFileTypeOrListOfFiles(accounts)) { - fileTypeFound = true; - } - - if (accounts.getClass().equals(java.io.File.class) - || accounts.getClass().equals(Integer.class) - || accounts.getClass().equals(String.class) - || accounts.getClass().isEnum()) { - map.put("accounts", accounts); - } else if (isListOfFile(accounts)) { - for (int i = 0; i < getListSize(accounts); i++) { - map.put("accounts[" + i + "]", getFromList(accounts, i)); - } - } else { - map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 901e4be34..8397c2dc6 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -26,11 +26,11 @@ /** TemplateResponseAccount */ @JsonPropertyOrder({ TemplateResponseAccount.JSON_PROPERTY_ACCOUNT_ID, - TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS, TemplateResponseAccount.JSON_PROPERTY_IS_LOCKED, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HS, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HF, - TemplateResponseAccount.JSON_PROPERTY_QUOTAS + TemplateResponseAccount.JSON_PROPERTY_QUOTAS, + TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -40,9 +40,6 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; private String accountId; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; @@ -55,6 +52,9 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private TemplateResponseAccountQuota quotas; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public TemplateResponseAccount() {} /** @@ -82,40 +82,19 @@ public TemplateResponseAccount accountId(String accountId) { * * @return accountId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getAccountId() { return accountId; } @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccountId(String accountId) { this.accountId = accountId; } - public TemplateResponseAccount emailAddress(String emailAddress) { - this.emailAddress = emailAddress; - return this; - } - - /** - * The email address associated with the Account. - * - * @return emailAddress - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getEmailAddress() { - return emailAddress; - } - - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { - this.emailAddress = emailAddress; - } - public TemplateResponseAccount isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -126,14 +105,15 @@ public TemplateResponseAccount isLocked(Boolean isLocked) { * * @return isLocked */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_LOCKED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsLocked() { return isLocked; } @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } @@ -148,14 +128,15 @@ public TemplateResponseAccount isPaidHs(Boolean isPaidHs) { * * @return isPaidHs */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_PAID_HS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHs() { return isPaidHs; } @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHs(Boolean isPaidHs) { this.isPaidHs = isPaidHs; } @@ -170,14 +151,15 @@ public TemplateResponseAccount isPaidHf(Boolean isPaidHf) { * * @return isPaidHf */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_PAID_HF) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHf() { return isPaidHf; } @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHf(Boolean isPaidHf) { this.isPaidHf = isPaidHf; } @@ -192,18 +174,41 @@ public TemplateResponseAccount quotas(TemplateResponseAccountQuota quotas) { * * @return quotas */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_QUOTAS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseAccountQuota getQuotas() { return quotas; } @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setQuotas(TemplateResponseAccountQuota quotas) { this.quotas = quotas; } + public TemplateResponseAccount emailAddress(String emailAddress) { + this.emailAddress = emailAddress; + return this; + } + + /** + * The email address associated with the Account. + * + * @return emailAddress + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getEmailAddress() { + return emailAddress; + } + + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEmailAddress(String emailAddress) { + this.emailAddress = emailAddress; + } + /** Return true if this TemplateResponseAccount object is equal to o. */ @Override public boolean equals(Object o) { @@ -215,16 +220,16 @@ public boolean equals(Object o) { } TemplateResponseAccount templateResponseAccount = (TemplateResponseAccount) o; return Objects.equals(this.accountId, templateResponseAccount.accountId) - && Objects.equals(this.emailAddress, templateResponseAccount.emailAddress) && Objects.equals(this.isLocked, templateResponseAccount.isLocked) && Objects.equals(this.isPaidHs, templateResponseAccount.isPaidHs) && Objects.equals(this.isPaidHf, templateResponseAccount.isPaidHf) - && Objects.equals(this.quotas, templateResponseAccount.quotas); + && Objects.equals(this.quotas, templateResponseAccount.quotas) + && Objects.equals(this.emailAddress, templateResponseAccount.emailAddress); } @Override public int hashCode() { - return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas); + return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress); } @Override @@ -232,11 +237,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseAccount {\n"); sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); - sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); sb.append(" isPaidHs: ").append(toIndentedString(isPaidHs)).append("\n"); sb.append(" isPaidHf: ").append(toIndentedString(isPaidHf)).append("\n"); sb.append(" quotas: ").append(toIndentedString(quotas)).append("\n"); + sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append("}"); return sb.toString(); } @@ -265,26 +270,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(accountId)); } } - if (emailAddress != null) { - if (isFileTypeOrListOfFiles(emailAddress)) { - fileTypeFound = true; - } - - if (emailAddress.getClass().equals(java.io.File.class) - || emailAddress.getClass().equals(Integer.class) - || emailAddress.getClass().equals(String.class) - || emailAddress.getClass().isEnum()) { - map.put("email_address", emailAddress); - } else if (isListOfFile(emailAddress)) { - for (int i = 0; i < getListSize(emailAddress); i++) { - map.put("email_address[" + i + "]", getFromList(emailAddress, i)); - } - } else { - map.put( - "email_address", - JSON.getDefault().getMapper().writeValueAsString(emailAddress)); - } - } if (isLocked != null) { if (isFileTypeOrListOfFiles(isLocked)) { fileTypeFound = true; @@ -363,6 +348,26 @@ public Map createFormData() throws ApiException { map.put("quotas", JSON.getDefault().getMapper().writeValueAsString(quotas)); } } + if (emailAddress != null) { + if (isFileTypeOrListOfFiles(emailAddress)) { + fileTypeFound = true; + } + + if (emailAddress.getClass().equals(java.io.File.class) + || emailAddress.getClass().equals(Integer.class) + || emailAddress.getClass().equals(String.class) + || emailAddress.getClass().isEnum()) { + map.put("email_address", emailAddress); + } else if (isListOfFile(emailAddress)) { + for (int i = 0; i < getListSize(emailAddress); i++) { + map.put("email_address[" + i + "]", getFromList(emailAddress, i)); + } + } else { + map.put( + "email_address", + JSON.getDefault().getMapper().writeValueAsString(emailAddress)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 0ebdbe2a4..37e680526 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -79,14 +79,15 @@ public TemplateResponseAccountQuota templatesLeft(Integer templatesLeft) { * * @return templatesLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getTemplatesLeft() { return templatesLeft; } @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplatesLeft(Integer templatesLeft) { this.templatesLeft = templatesLeft; } @@ -101,14 +102,15 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft(Integer apiSignatur * * @return apiSignatureRequestsLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getApiSignatureRequestsLeft() { return apiSignatureRequestsLeft; } @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } @@ -123,14 +125,15 @@ public TemplateResponseAccountQuota documentsLeft(Integer documentsLeft) { * * @return documentsLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getDocumentsLeft() { return documentsLeft; } @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDocumentsLeft(Integer documentsLeft) { this.documentsLeft = documentsLeft; } @@ -145,14 +148,15 @@ public TemplateResponseAccountQuota smsVerificationsLeft(Integer smsVerification * * @return smsVerificationsLeft */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getSmsVerificationsLeft() { return smsVerificationsLeft; } @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index e4a7d7377..d360b16dc 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -60,14 +60,15 @@ public TemplateResponseCCRole name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index de32fb5ac..a76ceca5d 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -28,11 +28,11 @@ /** TemplateResponseDocument */ @JsonPropertyOrder({ TemplateResponseDocument.JSON_PROPERTY_NAME, - TemplateResponseDocument.JSON_PROPERTY_INDEX, TemplateResponseDocument.JSON_PROPERTY_FIELD_GROUPS, TemplateResponseDocument.JSON_PROPERTY_FORM_FIELDS, TemplateResponseDocument.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS + TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS, + TemplateResponseDocument.JSON_PROPERTY_INDEX }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -42,20 +42,20 @@ public class TemplateResponseDocument { public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_INDEX = "index"; - private Integer index; - public static final String JSON_PROPERTY_FIELD_GROUPS = "field_groups"; - private List fieldGroups = null; + private List fieldGroups = new ArrayList<>(); public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; - private List formFields = null; + private List formFields = new ArrayList<>(); public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; - private List customFields = null; + private List customFields = new ArrayList<>(); public static final String JSON_PROPERTY_STATIC_FIELDS = "static_fields"; - private List staticFields = null; + private List staticFields = new ArrayList<>(); + + public static final String JSON_PROPERTY_INDEX = "index"; + private Integer index; public TemplateResponseDocument() {} @@ -85,41 +85,19 @@ public TemplateResponseDocument name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocument index(Integer index) { - this.index = index; - return this; - } - - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based - * indexing). - * - * @return index - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Integer getIndex() { - return index; - } - - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIndex(Integer index) { - this.index = index; - } - public TemplateResponseDocument fieldGroups( List fieldGroups) { this.fieldGroups = fieldGroups; @@ -140,14 +118,15 @@ public TemplateResponseDocument addFieldGroupsItem( * * @return fieldGroups */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFieldGroups() { return fieldGroups; } @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; } @@ -172,14 +151,15 @@ public TemplateResponseDocument addFormFieldsItem( * * @return formFields */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FORM_FIELDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFormFields() { return formFields; } @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFormFields(List formFields) { this.formFields = formFields; } @@ -204,14 +184,15 @@ public TemplateResponseDocument addCustomFieldsItem( * * @return customFields */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getCustomFields() { return customFields; } @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCustomFields(List customFields) { this.customFields = customFields; } @@ -237,18 +218,42 @@ public TemplateResponseDocument addStaticFieldsItem( * * @return staticFields */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getStaticFields() { return staticFields; } @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStaticFields(List staticFields) { this.staticFields = staticFields; } + public TemplateResponseDocument index(Integer index) { + this.index = index; + return this; + } + + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based + * indexing). + * + * @return index + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getIndex() { + return index; + } + + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIndex(Integer index) { + this.index = index; + } + /** Return true if this TemplateResponseDocument object is equal to o. */ @Override public boolean equals(Object o) { @@ -260,16 +265,16 @@ public boolean equals(Object o) { } TemplateResponseDocument templateResponseDocument = (TemplateResponseDocument) o; return Objects.equals(this.name, templateResponseDocument.name) - && Objects.equals(this.index, templateResponseDocument.index) && Objects.equals(this.fieldGroups, templateResponseDocument.fieldGroups) && Objects.equals(this.formFields, templateResponseDocument.formFields) && Objects.equals(this.customFields, templateResponseDocument.customFields) - && Objects.equals(this.staticFields, templateResponseDocument.staticFields); + && Objects.equals(this.staticFields, templateResponseDocument.staticFields) + && Objects.equals(this.index, templateResponseDocument.index); } @Override public int hashCode() { - return Objects.hash(name, index, fieldGroups, formFields, customFields, staticFields); + return Objects.hash(name, fieldGroups, formFields, customFields, staticFields, index); } @Override @@ -277,11 +282,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocument {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append(" fieldGroups: ").append(toIndentedString(fieldGroups)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" staticFields: ").append(toIndentedString(staticFields)).append("\n"); + sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append("}"); return sb.toString(); } @@ -308,24 +313,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (index != null) { - if (isFileTypeOrListOfFiles(index)) { - fileTypeFound = true; - } - - if (index.getClass().equals(java.io.File.class) - || index.getClass().equals(Integer.class) - || index.getClass().equals(String.class) - || index.getClass().isEnum()) { - map.put("index", index); - } else if (isListOfFile(index)) { - for (int i = 0; i < getListSize(index); i++) { - map.put("index[" + i + "]", getFromList(index, i)); - } - } else { - map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); - } - } if (fieldGroups != null) { if (isFileTypeOrListOfFiles(fieldGroups)) { fileTypeFound = true; @@ -406,6 +393,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(staticFields)); } } + if (index != null) { + if (isFileTypeOrListOfFiles(index)) { + fileTypeFound = true; + } + + if (index.getClass().equals(java.io.File.class) + || index.getClass().equals(Integer.class) + || index.getClass().equals(String.class) + || index.getClass().isEnum()) { + map.put("index", index); + } else if (isListOfFile(index)) { + for (int i = 0; i < getListSize(index); i++) { + map.put("index[" + i + "]", getFromList(index, i)); + } + } else { + map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index d6c0d010c..1458076c7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -27,15 +27,15 @@ /** An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_HEIGHT, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_REQUIRED, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_GROUP }) @javax.annotation.Generated( @@ -56,17 +56,14 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentCustomFieldText.class, name = "text"), }) public class TemplateResponseDocumentCustomFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_SIGNER = "signer"; - private String signer; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; public static final String JSON_PROPERTY_X = "x"; private Integer x; @@ -83,6 +80,9 @@ public class TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; + public static final String JSON_PROPERTY_SIGNER = "signer"; + private String signer; + public static final String JSON_PROPERTY_GROUP = "group"; private String group; @@ -105,29 +105,6 @@ public static TemplateResponseDocumentCustomFieldBase init(HashMap data) throws TemplateResponseDocumentCustomFieldBase.class); } - public TemplateResponseDocumentCustomFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -138,14 +115,15 @@ public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -160,48 +138,40 @@ public TemplateResponseDocumentCustomFieldBase name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentCustomFieldBase signer(String signer) { - this.signer = signer; - return this; - } - - public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { - this.signer = String.valueOf(signer); + public TemplateResponseDocumentCustomFieldBase type(String type) { + this.type = type; return this; } /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned - * to Sender). + * Get type * - * @return signer + * @return type */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getSigner() { - return signer; - } - - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { - this.signer = signer; + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; } - public void setSigner(Integer signer) { - this.signer = String.valueOf(signer); + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; } public TemplateResponseDocumentCustomFieldBase x(Integer x) { @@ -214,14 +184,15 @@ public TemplateResponseDocumentCustomFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -236,14 +207,15 @@ public TemplateResponseDocumentCustomFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -258,14 +230,15 @@ public TemplateResponseDocumentCustomFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -280,14 +253,15 @@ public TemplateResponseDocumentCustomFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -302,18 +276,51 @@ public TemplateResponseDocumentCustomFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } + public TemplateResponseDocumentCustomFieldBase signer(String signer) { + this.signer = signer; + return this; + } + + public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { + this.signer = String.valueOf(signer); + return this; + } + + /** + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned + * to Sender). + * + * @return signer + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getSigner() { + return signer; + } + + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigner(String signer) { + this.signer = signer; + } + + public void setSigner(Integer signer) { + this.signer = String.valueOf(signer); + } + public TemplateResponseDocumentCustomFieldBase group(String group) { this.group = group; return this; @@ -348,36 +355,36 @@ public boolean equals(Object o) { } TemplateResponseDocumentCustomFieldBase templateResponseDocumentCustomFieldBase = (TemplateResponseDocumentCustomFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) - && Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) + return Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentCustomFieldBase.name) - && Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) + && Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && Objects.equals(this.x, templateResponseDocumentCustomFieldBase.x) && Objects.equals(this.y, templateResponseDocumentCustomFieldBase.y) && Objects.equals(this.width, templateResponseDocumentCustomFieldBase.width) && Objects.equals(this.height, templateResponseDocumentCustomFieldBase.height) && Objects.equals(this.required, templateResponseDocumentCustomFieldBase.required) + && Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.group, templateResponseDocumentCustomFieldBase.group); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, x, y, width, height, required, signer, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentCustomFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); @@ -387,24 +394,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -441,22 +430,22 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (signer != null) { - if (isFileTypeOrListOfFiles(signer)) { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { fileTypeFound = true; } - if (signer.getClass().equals(java.io.File.class) - || signer.getClass().equals(Integer.class) - || signer.getClass().equals(String.class) - || signer.getClass().isEnum()) { - map.put("signer", signer); - } else if (isListOfFile(signer)) { - for (int i = 0; i < getListSize(signer); i++) { - map.put("signer[" + i + "]", getFromList(signer, i)); + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); } } else { - map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } if (x != null) { @@ -549,6 +538,24 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } + if (signer != null) { + if (isFileTypeOrListOfFiles(signer)) { + fileTypeFound = true; + } + + if (signer.getClass().equals(java.io.File.class) + || signer.getClass().equals(Integer.class) + || signer.getClass().equals(String.class) + || signer.getClass().isEnum()) { + map.put("signer", signer); + } else if (isListOfFile(signer)) { + for (int i = 0; i < getListSize(signer); i++) { + map.put("signer[" + i + "]", getFromList(signer, i)); + } + } else { + map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + } + } if (group != null) { if (isFileTypeOrListOfFiles(group)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index e915dc017..7fdf99be8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -115,14 +115,15 @@ public TemplateResponseDocumentCustomFieldText avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -137,14 +138,15 @@ public TemplateResponseDocumentCustomFieldText isMultiline(Boolean isMultiline) * * @return isMultiline */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -159,14 +161,15 @@ public TemplateResponseDocumentCustomFieldText originalFontSize(Integer original * * @return originalFontSize */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -181,14 +184,15 @@ public TemplateResponseDocumentCustomFieldText fontFamily(String fontFamily) { * * @return fontFamily */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index 27dd50e83..b362998bf 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -67,14 +67,15 @@ public TemplateResponseDocumentFieldGroup name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -89,14 +90,15 @@ public TemplateResponseDocumentFieldGroup rule(TemplateResponseDocumentFieldGrou * * @return rule */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_RULE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseDocumentFieldGroupRule getRule() { return rule; } @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRule(TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index 0fa796c46..fd8e15836 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -75,14 +75,15 @@ public TemplateResponseDocumentFieldGroupRule requirement(String requirement) { * * @return requirement */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIREMENT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getRequirement() { return requirement; } @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequirement(String requirement) { this.requirement = requirement; } @@ -97,14 +98,15 @@ public TemplateResponseDocumentFieldGroupRule groupLabel(String groupLabel) { * * @return groupLabel */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_GROUP_LABEL) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getGroupLabel() { return groupLabel; } @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setGroupLabel(String groupLabel) { this.groupLabel = groupLabel; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index 86b997464..56639bb69 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -27,16 +27,15 @@ /** An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_HEIGHT, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_GROUP + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -66,15 +65,15 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentFormFieldText.class, name = "text"), }) public class TemplateResponseDocumentFormFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer; @@ -93,9 +92,6 @@ public class TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; - public static final String JSON_PROPERTY_GROUP = "group"; - private String group; - public TemplateResponseDocumentFormFieldBase() {} /** @@ -114,29 +110,6 @@ public static TemplateResponseDocumentFormFieldBase init(HashMap data) throws Ex TemplateResponseDocumentFormFieldBase.class); } - public TemplateResponseDocumentFormFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentFormFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -147,14 +120,15 @@ public TemplateResponseDocumentFormFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -169,18 +143,42 @@ public TemplateResponseDocumentFormFieldBase name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentFormFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * + * @return type + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + public TemplateResponseDocumentFormFieldBase signer(String signer) { this.signer = signer; return this; @@ -196,14 +194,15 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { * * @return signer */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; } @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -222,14 +221,15 @@ public TemplateResponseDocumentFormFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -244,14 +244,15 @@ public TemplateResponseDocumentFormFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -266,14 +267,15 @@ public TemplateResponseDocumentFormFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -288,14 +290,15 @@ public TemplateResponseDocumentFormFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -310,41 +313,19 @@ public TemplateResponseDocumentFormFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } - public TemplateResponseDocumentFormFieldBase group(String group) { - this.group = group; - return this; - } - - /** - * The name of the group this field is in. If this field is not a group, this defaults to - * `null` except for Radio fields. - * - * @return group - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getGroup() { - return group; - } - - @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { - this.group = group; - } - /** Return true if this TemplateResponseDocumentFormFieldBase object is equal to o. */ @Override public boolean equals(Object o) { @@ -356,37 +337,35 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldBase templateResponseDocumentFormFieldBase = (TemplateResponseDocumentFormFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) - && Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) + return Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentFormFieldBase.name) + && Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentFormFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentFormFieldBase.x) && Objects.equals(this.y, templateResponseDocumentFormFieldBase.y) && Objects.equals(this.width, templateResponseDocumentFormFieldBase.width) && Objects.equals(this.height, templateResponseDocumentFormFieldBase.height) - && Objects.equals(this.required, templateResponseDocumentFormFieldBase.required) - && Objects.equals(this.group, templateResponseDocumentFormFieldBase.group); + && Objects.equals(this.required, templateResponseDocumentFormFieldBase.required); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentFormFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); - sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -395,24 +374,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -449,6 +410,24 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; @@ -557,24 +536,6 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } - if (group != null) { - if (isFileTypeOrListOfFiles(group)) { - fileTypeFound = true; - } - - if (group.getClass().equals(java.io.File.class) - || group.getClass().equals(Integer.class) - || group.getClass().equals(String.class) - || group.getClass().isEnum()) { - map.put("group", group); - } else if (isListOfFile(group)) { - for (int i = 0; i < getListSize(group); i++) { - map.put("group[" + i + "]", getFromList(group, i)); - } - } else { - map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java index e7469c5a5..b291ffdd8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldCheckbox public static final String JSON_PROPERTY_TYPE = "type"; private String type = "checkbox"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldCheckbox() {} /** @@ -92,6 +98,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldCheckbox group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldCheckbox object is equal to o. */ @Override public boolean equals(Object o) { @@ -104,12 +133,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldCheckbox templateResponseDocumentFormFieldCheckbox = (TemplateResponseDocumentFormFieldCheckbox) o; return Objects.equals(this.type, templateResponseDocumentFormFieldCheckbox.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldCheckbox.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -118,6 +148,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldCheckbox {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -145,6 +176,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java index 47a664adb..b43906f05 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldDateSigned public static final String JSON_PROPERTY_TYPE = "type"; private String type = "date_signed"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDateSigned() {} /** @@ -93,6 +99,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldDateSigned group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldDateSigned object is equal to o. */ @Override public boolean equals(Object o) { @@ -105,12 +134,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldDateSigned templateResponseDocumentFormFieldDateSigned = (TemplateResponseDocumentFormFieldDateSigned) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDateSigned.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldDateSigned.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -119,6 +149,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDateSigned {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -146,6 +177,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java index 548aebe5a..1c6289c42 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldDropdown public static final String JSON_PROPERTY_TYPE = "type"; private String type = "dropdown"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDropdown() {} /** @@ -92,6 +98,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldDropdown group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldDropdown object is equal to o. */ @Override public boolean equals(Object o) { @@ -104,12 +133,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldDropdown templateResponseDocumentFormFieldDropdown = (TemplateResponseDocumentFormFieldDropdown) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDropdown.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldDropdown.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -118,6 +148,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDropdown {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -145,6 +176,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index 71ed8a6b1..c42b580b3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -30,7 +30,8 @@ TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_AVG_TEXT_LENGTH, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_ORIGINAL_FONT_SIZE, - TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY, + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_GROUP }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -60,6 +61,9 @@ public class TemplateResponseDocumentFormFieldHyperlink public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; private String fontFamily; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldHyperlink() {} /** @@ -122,14 +126,15 @@ public TemplateResponseDocumentFormFieldHyperlink avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -144,14 +149,15 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline(Boolean isMultilin * * @return isMultiline */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -166,14 +172,15 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize(Integer origi * * @return originalFontSize */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -188,18 +195,42 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily(String fontFamily) * * @return fontFamily */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } + public TemplateResponseDocumentFormFieldHyperlink group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldHyperlink object is equal to o. */ @Override public boolean equals(Object o) { @@ -222,13 +253,20 @@ public boolean equals(Object o) { templateResponseDocumentFormFieldHyperlink.originalFontSize) && Objects.equals( this.fontFamily, templateResponseDocumentFormFieldHyperlink.fontFamily) + && Objects.equals(this.group, templateResponseDocumentFormFieldHyperlink.group) && super.equals(o); } @Override public int hashCode() { return Objects.hash( - type, avgTextLength, isMultiline, originalFontSize, fontFamily, super.hashCode()); + type, + avgTextLength, + isMultiline, + originalFontSize, + fontFamily, + group, + super.hashCode()); } @Override @@ -241,6 +279,7 @@ public String toString() { sb.append(" isMultiline: ").append(toIndentedString(isMultiline)).append("\n"); sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -348,6 +387,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(fontFamily)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java index b2a1c740b..17bc3553e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldInitials public static final String JSON_PROPERTY_TYPE = "type"; private String type = "initials"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldInitials() {} /** @@ -92,6 +98,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldInitials group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldInitials object is equal to o. */ @Override public boolean equals(Object o) { @@ -104,12 +133,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldInitials templateResponseDocumentFormFieldInitials = (TemplateResponseDocumentFormFieldInitials) o; return Objects.equals(this.type, templateResponseDocumentFormFieldInitials.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldInitials.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -118,6 +148,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldInitials {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -145,6 +176,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java index a9f10772c..75b7a72ad 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -41,6 +44,9 @@ public class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu public static final String JSON_PROPERTY_TYPE = "type"; private String type = "radio"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldRadio() {} /** @@ -90,6 +96,30 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldRadio group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldRadio object is equal to o. */ @Override public boolean equals(Object o) { @@ -102,12 +132,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldRadio templateResponseDocumentFormFieldRadio = (TemplateResponseDocumentFormFieldRadio) o; return Objects.equals(this.type, templateResponseDocumentFormFieldRadio.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldRadio.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -116,6 +147,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldRadio {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -143,6 +175,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java index 4155ba402..15630a485 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java @@ -25,7 +25,10 @@ import java.util.Objects; /** This class extends `TemplateResponseDocumentFormFieldBase` */ -@JsonPropertyOrder({TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE}) +@JsonPropertyOrder({ + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_GROUP +}) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -42,6 +45,9 @@ public class TemplateResponseDocumentFormFieldSignature public static final String JSON_PROPERTY_TYPE = "type"; private String type = "signature"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldSignature() {} /** @@ -93,6 +99,29 @@ public void setType(String type) { this.type = type; } + public TemplateResponseDocumentFormFieldSignature group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldSignature object is equal to o. */ @Override public boolean equals(Object o) { @@ -105,12 +134,13 @@ public boolean equals(Object o) { TemplateResponseDocumentFormFieldSignature templateResponseDocumentFormFieldSignature = (TemplateResponseDocumentFormFieldSignature) o; return Objects.equals(this.type, templateResponseDocumentFormFieldSignature.type) + && Objects.equals(this.group, templateResponseDocumentFormFieldSignature.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -119,6 +149,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldSignature {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -146,6 +177,24 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index 070454b47..e7176f5ea 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -33,7 +33,8 @@ TemplateResponseDocumentFormFieldText.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_ORIGINAL_FONT_SIZE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_FONT_FAMILY, - TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE, + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_GROUP }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -118,6 +119,9 @@ public static ValidationTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_VALIDATION_TYPE = "validation_type"; private ValidationTypeEnum validationType; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldText() {} /** @@ -178,14 +182,15 @@ public TemplateResponseDocumentFormFieldText avgTextLength( * * @return avgTextLength */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; } @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -200,14 +205,15 @@ public TemplateResponseDocumentFormFieldText isMultiline(Boolean isMultiline) { * * @return isMultiline */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_IS_MULTILINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; } @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -222,14 +228,15 @@ public TemplateResponseDocumentFormFieldText originalFontSize(Integer originalFo * * @return originalFontSize */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; } @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -244,14 +251,15 @@ public TemplateResponseDocumentFormFieldText fontFamily(String fontFamily) { * * @return fontFamily */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_FONT_FAMILY) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; } @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } @@ -280,6 +288,29 @@ public void setValidationType(ValidationTypeEnum validationType) { this.validationType = validationType; } + public TemplateResponseDocumentFormFieldText group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to + * `null` except for Radio fields. + * + * @return group + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getGroup() { + return group; + } + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + /** Return true if this TemplateResponseDocumentFormFieldText object is equal to o. */ @Override public boolean equals(Object o) { @@ -302,6 +333,7 @@ public boolean equals(Object o) { && Objects.equals(this.fontFamily, templateResponseDocumentFormFieldText.fontFamily) && Objects.equals( this.validationType, templateResponseDocumentFormFieldText.validationType) + && Objects.equals(this.group, templateResponseDocumentFormFieldText.group) && super.equals(o); } @@ -314,6 +346,7 @@ public int hashCode() { originalFontSize, fontFamily, validationType, + group, super.hashCode()); } @@ -328,6 +361,7 @@ public String toString() { sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); sb.append(" validationType: ").append(toIndentedString(validationType)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -455,6 +489,24 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(validationType)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) + || group.getClass().equals(Integer.class) + || group.getClass().equals(String.class) + || group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for (int i = 0; i < getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 164ee218b..6595dccd8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -29,9 +29,9 @@ * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ @JsonPropertyOrder({ - TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_Y, @@ -74,15 +74,15 @@ @JsonSubTypes.Type(value = TemplateResponseDocumentStaticFieldText.class, name = "text"), }) public class TemplateResponseDocumentStaticFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer = "me_now"; @@ -123,29 +123,6 @@ public static TemplateResponseDocumentStaticFieldBase init(HashMap data) throws TemplateResponseDocumentStaticFieldBase.class); } - public TemplateResponseDocumentStaticFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * - * @return type - */ - @javax.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getType() { - return type; - } - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -156,14 +133,15 @@ public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { * * @return apiId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_API_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; } @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -178,18 +156,42 @@ public TemplateResponseDocumentStaticFieldBase name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentStaticFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * + * @return type + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public String getType() { + return type; + } + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + public TemplateResponseDocumentStaticFieldBase signer(String signer) { this.signer = signer; return this; @@ -200,14 +202,15 @@ public TemplateResponseDocumentStaticFieldBase signer(String signer) { * * @return signer */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; } @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -222,14 +225,15 @@ public TemplateResponseDocumentStaticFieldBase x(Integer x) { * * @return x */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_X) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; } @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -244,14 +248,15 @@ public TemplateResponseDocumentStaticFieldBase y(Integer y) { * * @return y */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_Y) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; } @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -266,14 +271,15 @@ public TemplateResponseDocumentStaticFieldBase width(Integer width) { * * @return width */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_WIDTH) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; } @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -288,14 +294,15 @@ public TemplateResponseDocumentStaticFieldBase height(Integer height) { * * @return height */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_HEIGHT) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; } @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -310,14 +317,15 @@ public TemplateResponseDocumentStaticFieldBase required(Boolean required) { * * @return required */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_REQUIRED) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; } @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } @@ -356,9 +364,9 @@ public boolean equals(Object o) { } TemplateResponseDocumentStaticFieldBase templateResponseDocumentStaticFieldBase = (TemplateResponseDocumentStaticFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) - && Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) + return Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentStaticFieldBase.name) + && Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentStaticFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentStaticFieldBase.x) && Objects.equals(this.y, templateResponseDocumentStaticFieldBase.y) @@ -370,16 +378,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentStaticFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -395,24 +403,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) - || type.getClass().equals(Integer.class) - || type.getClass().equals(String.class) - || type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for (int i = 0; i < getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -449,6 +439,24 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) + || type.getClass().equals(Integer.class) + || type.getClass().equals(String.class) + || type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for (int i = 0; i < getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index b5a9afb52..375fc0737 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -67,14 +67,15 @@ public TemplateResponseFieldAvgTextLength numLines(Integer numLines) { * * @return numLines */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NUM_LINES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumLines() { return numLines; } @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumLines(Integer numLines) { this.numLines = numLines; } @@ -89,14 +90,15 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine(Integer numCharsPerLin * * @return numCharsPerLine */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumCharsPerLine() { return numCharsPerLine; } @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumCharsPerLine(Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index 4724f47e5..d6697fef8 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -67,14 +67,15 @@ public TemplateResponseSignerRole name(String name) { * * @return name */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; } @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 08f0784e7..66a058873 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -69,14 +69,15 @@ public TemplateUpdateFilesResponseTemplate templateId(String templateId) { * * @return templateId */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; } @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v2/docs/OAuthApi.md b/sdks/java-v2/docs/OAuthApi.md index a2eaa2508..533052ba2 100644 --- a/sdks/java-v2/docs/OAuthApi.md +++ b/sdks/java-v2/docs/OAuthApi.md @@ -77,7 +77,6 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -| **4XX** | failed_operation | - | ## oauthTokenRefresh @@ -145,5 +144,4 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -| **4XX** | failed_operation | - | diff --git a/sdks/java-v2/docs/OAuthTokenRefreshRequest.md b/sdks/java-v2/docs/OAuthTokenRefreshRequest.md index f0ce43061..2b985fa91 100644 --- a/sdks/java-v2/docs/OAuthTokenRefreshRequest.md +++ b/sdks/java-v2/docs/OAuthTokenRefreshRequest.md @@ -10,8 +10,6 @@ |------------ | ------------- | ------------- | -------------| | `grantType`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | | | `refreshToken`*_required_ | ```String``` | The token provided when you got the expired access token. | | -| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | -| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 770cce434..224ec6c71 100644 --- a/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -8,9 +8,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `editUrl` | ```String``` | Link to edit the template. | | -| `expiresAt` | ```Integer``` | When the link expires. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `editUrl`*_required_ | ```String``` | Link to edit the template. | | +| `expiresAt`*_required_ | ```Integer``` | When the link expires. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md index 1dcd4bd79..79801d898 100644 --- a/sdks/java-v2/docs/TemplateCreateResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateCreateResponseTemplate.md @@ -8,7 +8,7 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | diff --git a/sdks/java-v2/docs/TemplateResponse.md b/sdks/java-v2/docs/TemplateResponse.md index 078685ff1..323e905f6 100644 --- a/sdks/java-v2/docs/TemplateResponse.md +++ b/sdks/java-v2/docs/TemplateResponse.md @@ -8,21 +8,22 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | +| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | | `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `isCreator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | | `metadata` | ```Object``` | The metadata attached to the template. | | | `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | | `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | diff --git a/sdks/java-v2/docs/TemplateResponseAccount.md b/sdks/java-v2/docs/TemplateResponseAccount.md index 10c996408..dd8ebce7f 100644 --- a/sdks/java-v2/docs/TemplateResponseAccount.md +++ b/sdks/java-v2/docs/TemplateResponseAccount.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `accountId` | ```String``` | The id of the Account. | | +| `accountId`*_required_ | ```String``` | The id of the Account. | | +| `isLocked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | | `emailAddress` | ```String``` | The email address associated with the Account. | | -| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseAccountQuota.md b/sdks/java-v2/docs/TemplateResponseAccountQuota.md index ad94c2493..72160ca8f 100644 --- a/sdks/java-v2/docs/TemplateResponseAccountQuota.md +++ b/sdks/java-v2/docs/TemplateResponseAccountQuota.md @@ -8,10 +8,10 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templatesLeft` | ```Integer``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | | -| `documentsLeft` | ```Integer``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```Integer``` | SMS verifications remaining. | | +| `templatesLeft`*_required_ | ```Integer``` | API templates remaining. | | +| `apiSignatureRequestsLeft`*_required_ | ```Integer``` | API signature requests remaining. | | +| `documentsLeft`*_required_ | ```Integer``` | Signature requests remaining. | | +| `smsVerificationsLeft`*_required_ | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/java-v2/docs/TemplateResponseCCRole.md b/sdks/java-v2/docs/TemplateResponseCCRole.md index 64069b826..06e61bff4 100644 --- a/sdks/java-v2/docs/TemplateResponseCCRole.md +++ b/sdks/java-v2/docs/TemplateResponseCCRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocument.md b/sdks/java-v2/docs/TemplateResponseDocument.md index 65da85d42..cb69a481f 100644 --- a/sdks/java-v2/docs/TemplateResponseDocument.md +++ b/sdks/java-v2/docs/TemplateResponseDocument.md @@ -8,12 +8,12 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | Name of the associated file. | | +| `name`*_required_ | ```String``` | Name of the associated file. | | +| `fieldGroups`*_required_ | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields`*_required_ | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields`*_required_ | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields`*_required_ | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```List```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md index edd461727..c7c7f8264 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldBase.md @@ -8,15 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | The unique ID for this field. | | +| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md index ccaf19394..70c991777 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentCustomFieldText.md @@ -9,10 +9,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md index 03b5ffbb8..7dd066f54 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroup.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```String``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md index e0f4dcc8a..59d4e5e06 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFieldGroupRule.md @@ -8,8 +8,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel` | ```String``` | Name of the group | | +| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel`*_required_ | ```String``` | Name of the group | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md index 656070ad4..8d8766339 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldBase.md @@ -8,16 +8,15 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the form field. | | +| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```String``` | The signer of the Form Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md index 83d36e0f1..a7f2cadeb 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md index 5ba66eff9..09b45eec7 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md index b4f2030fc..70e5da455 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md index 0cf89df5e..104029730 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -9,10 +9,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md index 707d67ee2..f1fe1f5b5 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldInitials.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md index b83d96d53..877b842a2 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldRadio.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md index 8be298793..366aaa9b4 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldSignature.md @@ -9,6 +9,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md index 3581d3855..31520bd6f 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentFormFieldText.md @@ -9,11 +9,12 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```Integer``` | Original font size used in this form field's text. | | -| `fontFamily` | ```String``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```String``` | Font family used in this form field's text. | | | `validationType` | [```ValidationTypeEnum```](#ValidationTypeEnum) | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md index 4be3cf070..f52329b04 100644 --- a/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/java-v2/docs/TemplateResponseDocumentStaticFieldBase.md @@ -8,15 +8,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| `apiId`*_required_ | ```String``` | A unique id for the static field. | | +| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `apiId` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```String``` | The signer of the Static Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md index bb66f3057..f0d2106b0 100644 --- a/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/java-v2/docs/TemplateResponseFieldAvgTextLength.md @@ -8,8 +8,8 @@ Average text length in this field. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `numLines` | ```Integer``` | Number of lines. | | -| `numCharsPerLine` | ```Integer``` | Number of characters per line. | | +| `numLines`*_required_ | ```Integer``` | Number of lines. | | +| `numCharsPerLine`*_required_ | ```Integer``` | Number of characters per line. | | diff --git a/sdks/java-v2/docs/TemplateResponseSignerRole.md b/sdks/java-v2/docs/TemplateResponseSignerRole.md index 15b48cf17..08458f4e0 100644 --- a/sdks/java-v2/docs/TemplateResponseSignerRole.md +++ b/sdks/java-v2/docs/TemplateResponseSignerRole.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md index 6289a9953..7acdbb340 100644 --- a/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/java-v2/docs/TemplateUpdateFilesResponseTemplate.md @@ -8,7 +8,7 @@ Contains template id | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `templateId` | ```String``` | The id of the Template. | | +| `templateId`*_required_ | ```String``` | The id of the Template. | | | `warnings` | [```List```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java index 4d881a94e..98b580202 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -8,7 +8,6 @@ import jakarta.ws.rs.core.GenericType; -import com.dropbox.sign.model.ErrorResponse; import com.dropbox.sign.model.OAuthTokenGenerateRequest; import com.dropbox.sign.model.OAuthTokenRefreshRequest; import com.dropbox.sign.model.OAuthTokenResponse; @@ -59,7 +58,6 @@ public void setApiClient(ApiClient apiClient) { -
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthTokenGenerateRequest) throws ApiException { @@ -77,7 +75,6 @@ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthToke -
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthTokenGenerateRequest oauthTokenGenerateRequest) throws ApiException { @@ -119,7 +116,6 @@ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthToken -
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest) throws ApiException { @@ -137,7 +133,6 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR -
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenRefreshWithHttpInfo(OAuthTokenRefreshRequest oauthTokenRefreshRequest) throws ApiException { diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java index fafe689fc..28eb1cdfb 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java @@ -34,9 +34,7 @@ */ @JsonPropertyOrder({ OAuthTokenRefreshRequest.JSON_PROPERTY_GRANT_TYPE, - OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN, - OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_ID, - OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_SECRET + OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -47,12 +45,6 @@ public class OAuthTokenRefreshRequest { public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; private String refreshToken; - public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; - private String clientId; - - public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; - private String clientSecret; - public OAuthTokenRefreshRequest() { } @@ -121,56 +113,6 @@ public void setRefreshToken(String refreshToken) { } - public OAuthTokenRefreshRequest clientId(String clientId) { - this.clientId = clientId; - return this; - } - - /** - * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - * @return clientId - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientId() { - return clientId; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { - this.clientId = clientId; - } - - - public OAuthTokenRefreshRequest clientSecret(String clientSecret) { - this.clientSecret = clientSecret; - return this; - } - - /** - * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - * @return clientSecret - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getClientSecret() { - return clientSecret; - } - - - @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientSecret(String clientSecret) { - this.clientSecret = clientSecret; - } - - /** * Return true if this OAuthTokenRefreshRequest object is equal to o. */ @@ -184,14 +126,12 @@ public boolean equals(Object o) { } OAuthTokenRefreshRequest oauthTokenRefreshRequest = (OAuthTokenRefreshRequest) o; return Objects.equals(this.grantType, oauthTokenRefreshRequest.grantType) && - Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken) && - Objects.equals(this.clientId, oauthTokenRefreshRequest.clientId) && - Objects.equals(this.clientSecret, oauthTokenRefreshRequest.clientSecret); + Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken); } @Override public int hashCode() { - return Objects.hash(grantType, refreshToken, clientId, clientSecret); + return Objects.hash(grantType, refreshToken); } @Override @@ -200,8 +140,6 @@ public String toString() { sb.append("class OAuthTokenRefreshRequest {\n"); sb.append(" grantType: ").append(toIndentedString(grantType)).append("\n"); sb.append(" refreshToken: ").append(toIndentedString(refreshToken)).append("\n"); - sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); - sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -248,44 +186,6 @@ public Map createFormData() throws ApiException { map.put("refresh_token", JSON.getDefault().getMapper().writeValueAsString(refreshToken)); } } - if (clientId != null) { - if (isFileTypeOrListOfFiles(clientId)) { - fileTypeFound = true; - } - - if (clientId.getClass().equals(java.io.File.class) || - clientId.getClass().equals(Integer.class) || - clientId.getClass().equals(String.class) || - clientId.getClass().isEnum()) { - map.put("client_id", clientId); - } else if (isListOfFile(clientId)) { - for(int i = 0; i< getListSize(clientId); i++) { - map.put("client_id[" + i + "]", getFromList(clientId, i)); - } - } - else { - map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); - } - } - if (clientSecret != null) { - if (isFileTypeOrListOfFiles(clientSecret)) { - fileTypeFound = true; - } - - if (clientSecret.getClass().equals(java.io.File.class) || - clientSecret.getClass().equals(Integer.class) || - clientSecret.getClass().equals(String.class) || - clientSecret.getClass().isEnum()) { - map.put("client_secret", clientSecret); - } else if (isListOfFile(clientSecret)) { - for(int i = 0; i< getListSize(clientSecret); i++) { - map.put("client_secret[" + i + "]", getFromList(clientSecret, i)); - } - } - else { - map.put("client_secret", JSON.getDefault().getMapper().writeValueAsString(clientSecret)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index f9c0286ac..d0d6ca141 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -84,9 +84,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate templateId(String templateId) * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -94,7 +94,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -109,9 +109,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate editUrl(String editUrl) { * Link to edit the template. * @return editUrl */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getEditUrl() { return editUrl; @@ -119,7 +119,7 @@ public String getEditUrl() { @JsonProperty(JSON_PROPERTY_EDIT_URL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setEditUrl(String editUrl) { this.editUrl = editUrl; } @@ -134,9 +134,9 @@ public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(Integer expiresAt) * When the link expires. * @return expiresAt */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getExpiresAt() { return expiresAt; @@ -144,7 +144,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setExpiresAt(Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index 6d668fd69..d070cfa45 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -68,9 +68,9 @@ public TemplateCreateResponseTemplate templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -78,7 +78,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 577975bea..f78dfbb26 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -16,6 +16,7 @@ import java.util.Objects; import java.util.Map; import java.util.HashMap; +import com.dropbox.sign.model.SignatureRequestResponseAttachment; import com.dropbox.sign.model.TemplateResponseAccount; import com.dropbox.sign.model.TemplateResponseCCRole; import com.dropbox.sign.model.TemplateResponseDocument; @@ -44,18 +45,19 @@ TemplateResponse.JSON_PROPERTY_TEMPLATE_ID, TemplateResponse.JSON_PROPERTY_TITLE, TemplateResponse.JSON_PROPERTY_MESSAGE, - TemplateResponse.JSON_PROPERTY_UPDATED_AT, - TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, + TemplateResponse.JSON_PROPERTY_DOCUMENTS, + TemplateResponse.JSON_PROPERTY_ACCOUNTS, + TemplateResponse.JSON_PROPERTY_ATTACHMENTS, + TemplateResponse.JSON_PROPERTY_UPDATED_AT, + TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, TemplateResponse.JSON_PROPERTY_METADATA, TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, TemplateResponse.JSON_PROPERTY_CC_ROLES, - TemplateResponse.JSON_PROPERTY_DOCUMENTS, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS, - TemplateResponse.JSON_PROPERTY_ACCOUNTS + TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -69,12 +71,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_MESSAGE = "message"; private String message; - public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; - private Integer updatedAt; - - public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; - private Boolean isEmbedded; - public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; private Boolean isCreator; @@ -84,6 +80,21 @@ public class TemplateResponse { public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; + public static final String JSON_PROPERTY_DOCUMENTS = "documents"; + private List documents = new ArrayList<>(); + + public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + private List accounts = new ArrayList<>(); + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + private List attachments = new ArrayList<>(); + + public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + private Integer updatedAt; + + public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; + private Boolean isEmbedded; + public static final String JSON_PROPERTY_METADATA = "metadata"; private Object metadata; @@ -93,9 +104,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; private List ccRoles = null; - public static final String JSON_PROPERTY_DOCUMENTS = "documents"; - private List documents = null; - public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated private List customFields = null; @@ -104,9 +112,6 @@ public class TemplateResponse { @Deprecated private List namedFormFields = null; - public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; - private List accounts = null; - public TemplateResponse() { } @@ -134,9 +139,9 @@ public TemplateResponse templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -144,7 +149,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } @@ -159,9 +164,9 @@ public TemplateResponse title(String title) { * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * @return title */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTitle() { return title; @@ -169,7 +174,7 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTitle(String title) { this.title = title; } @@ -184,9 +189,9 @@ public TemplateResponse message(String message) { * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * @return message */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getMessage() { return message; @@ -194,62 +199,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setMessage(String message) { this.message = message; } - public TemplateResponse updatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Time the template was last updated. - * @return updatedAt - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getUpdatedAt() { - return updatedAt; - } - - - @JsonProperty(JSON_PROPERTY_UPDATED_AT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { - this.updatedAt = updatedAt; - } - - - public TemplateResponse isEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - return this; - } - - /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. - * @return isEmbedded - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Boolean getIsEmbedded() { - return isEmbedded; - } - - - @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEmbedded(Boolean isEmbedded) { - this.isEmbedded = isEmbedded; - } - - public TemplateResponse isCreator(Boolean isCreator) { this.isCreator = isCreator; return this; @@ -259,9 +214,9 @@ public TemplateResponse isCreator(Boolean isCreator) { * `true` if you are the owner of this template, `false` if it's been shared with you by a team member. * @return isCreator */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsCreator() { return isCreator; @@ -269,7 +224,7 @@ public Boolean getIsCreator() { @JsonProperty(JSON_PROPERTY_IS_CREATOR) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsCreator(Boolean isCreator) { this.isCreator = isCreator; } @@ -284,9 +239,9 @@ public TemplateResponse canEdit(Boolean canEdit) { * Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). * @return canEdit */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getCanEdit() { return canEdit; @@ -294,7 +249,7 @@ public Boolean getCanEdit() { @JsonProperty(JSON_PROPERTY_CAN_EDIT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCanEdit(Boolean canEdit) { this.canEdit = canEdit; } @@ -309,9 +264,9 @@ public TemplateResponse isLocked(Boolean isLocked) { * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. * @return isLocked */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsLocked() { return isLocked; @@ -319,12 +274,161 @@ public Boolean getIsLocked() { @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } + public TemplateResponse documents(List documents) { + this.documents = documents; + return this; + } + + public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) { + if (this.documents == null) { + this.documents = new ArrayList<>(); + } + this.documents.add(documentsItem); + return this; + } + + /** + * An array describing each document associated with this Template. Includes form field data for each document. + * @return documents + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_DOCUMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getDocuments() { + return documents; + } + + + @JsonProperty(JSON_PROPERTY_DOCUMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setDocuments(List documents) { + this.documents = documents; + } + + + public TemplateResponse accounts(List accounts) { + this.accounts = accounts; + return this; + } + + public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { + if (this.accounts == null) { + this.accounts = new ArrayList<>(); + } + this.accounts.add(accountsItem); + return this; + } + + /** + * An array of the Accounts that can use this Template. + * @return accounts + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getAccounts() { + return accounts; + } + + + @JsonProperty(JSON_PROPERTY_ACCOUNTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAccounts(List accounts) { + this.accounts = accounts; + } + + + public TemplateResponse attachments(List attachments) { + this.attachments = attachments; + return this; + } + + public TemplateResponse addAttachmentsItem(SignatureRequestResponseAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * Signer attachments. + * @return attachments + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getAttachments() { + return attachments; + } + + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setAttachments(List attachments) { + this.attachments = attachments; + } + + + public TemplateResponse updatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + return this; + } + + /** + * Time the template was last updated. + * @return updatedAt + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getUpdatedAt() { + return updatedAt; + } + + + @JsonProperty(JSON_PROPERTY_UPDATED_AT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUpdatedAt(Integer updatedAt) { + this.updatedAt = updatedAt; + } + + + public TemplateResponse isEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + return this; + } + + /** + * `true` if this template was created using an embedded flow, `false` if it was created on our website. + * @return isEmbedded + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsEmbedded() { + return isEmbedded; + } + + + @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEmbedded(Boolean isEmbedded) { + this.isEmbedded = isEmbedded; + } + + public TemplateResponse metadata(Object metadata) { this.metadata = metadata; return this; @@ -416,39 +520,6 @@ public void setCcRoles(List ccRoles) { } - public TemplateResponse documents(List documents) { - this.documents = documents; - return this; - } - - public TemplateResponse addDocumentsItem(TemplateResponseDocument documentsItem) { - if (this.documents == null) { - this.documents = new ArrayList<>(); - } - this.documents.add(documentsItem); - return this; - } - - /** - * An array describing each document associated with this Template. Includes form field data for each document. - * @return documents - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getDocuments() { - return documents; - } - - - @JsonProperty(JSON_PROPERTY_DOCUMENTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDocuments(List documents) { - this.documents = documents; - } - - @Deprecated public TemplateResponse customFields(List customFields) { this.customFields = customFields; @@ -523,39 +594,6 @@ public void setNamedFormFields(List named } - public TemplateResponse accounts(List accounts) { - this.accounts = accounts; - return this; - } - - public TemplateResponse addAccountsItem(TemplateResponseAccount accountsItem) { - if (this.accounts == null) { - this.accounts = new ArrayList<>(); - } - this.accounts.add(accountsItem); - return this; - } - - /** - * An array of the Accounts that can use this Template. - * @return accounts - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getAccounts() { - return accounts; - } - - - @JsonProperty(JSON_PROPERTY_ACCOUNTS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccounts(List accounts) { - this.accounts = accounts; - } - - /** * Return true if this TemplateResponse object is equal to o. */ @@ -571,23 +609,24 @@ public boolean equals(Object o) { return Objects.equals(this.templateId, templateResponse.templateId) && Objects.equals(this.title, templateResponse.title) && Objects.equals(this.message, templateResponse.message) && - Objects.equals(this.updatedAt, templateResponse.updatedAt) && - Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) && + Objects.equals(this.documents, templateResponse.documents) && + Objects.equals(this.accounts, templateResponse.accounts) && + Objects.equals(this.attachments, templateResponse.attachments) && + Objects.equals(this.updatedAt, templateResponse.updatedAt) && + Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && Objects.equals(this.metadata, templateResponse.metadata) && Objects.equals(this.signerRoles, templateResponse.signerRoles) && Objects.equals(this.ccRoles, templateResponse.ccRoles) && - Objects.equals(this.documents, templateResponse.documents) && Objects.equals(this.customFields, templateResponse.customFields) && - Objects.equals(this.namedFormFields, templateResponse.namedFormFields) && - Objects.equals(this.accounts, templateResponse.accounts); + Objects.equals(this.namedFormFields, templateResponse.namedFormFields); } @Override public int hashCode() { - return Objects.hash(templateId, title, message, updatedAt, isEmbedded, isCreator, canEdit, isLocked, metadata, signerRoles, ccRoles, documents, customFields, namedFormFields, accounts); + return Objects.hash(templateId, title, message, isCreator, canEdit, isLocked, documents, accounts, attachments, updatedAt, isEmbedded, metadata, signerRoles, ccRoles, customFields, namedFormFields); } @Override @@ -597,18 +636,19 @@ public String toString() { sb.append(" templateId: ").append(toIndentedString(templateId)).append("\n"); sb.append(" title: ").append(toIndentedString(title)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); - sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); + sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); + sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); + sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); - sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); - sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); sb.append("}"); return sb.toString(); } @@ -674,44 +714,6 @@ public Map createFormData() throws ApiException { map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); } } - if (updatedAt != null) { - if (isFileTypeOrListOfFiles(updatedAt)) { - fileTypeFound = true; - } - - if (updatedAt.getClass().equals(java.io.File.class) || - updatedAt.getClass().equals(Integer.class) || - updatedAt.getClass().equals(String.class) || - updatedAt.getClass().isEnum()) { - map.put("updated_at", updatedAt); - } else if (isListOfFile(updatedAt)) { - for(int i = 0; i< getListSize(updatedAt); i++) { - map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); - } - } - else { - map.put("updated_at", JSON.getDefault().getMapper().writeValueAsString(updatedAt)); - } - } - if (isEmbedded != null) { - if (isFileTypeOrListOfFiles(isEmbedded)) { - fileTypeFound = true; - } - - if (isEmbedded.getClass().equals(java.io.File.class) || - isEmbedded.getClass().equals(Integer.class) || - isEmbedded.getClass().equals(String.class) || - isEmbedded.getClass().isEnum()) { - map.put("is_embedded", isEmbedded); - } else if (isListOfFile(isEmbedded)) { - for(int i = 0; i< getListSize(isEmbedded); i++) { - map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); - } - } - else { - map.put("is_embedded", JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); - } - } if (isCreator != null) { if (isFileTypeOrListOfFiles(isCreator)) { fileTypeFound = true; @@ -769,6 +771,101 @@ public Map createFormData() throws ApiException { map.put("is_locked", JSON.getDefault().getMapper().writeValueAsString(isLocked)); } } + if (documents != null) { + if (isFileTypeOrListOfFiles(documents)) { + fileTypeFound = true; + } + + if (documents.getClass().equals(java.io.File.class) || + documents.getClass().equals(Integer.class) || + documents.getClass().equals(String.class) || + documents.getClass().isEnum()) { + map.put("documents", documents); + } else if (isListOfFile(documents)) { + for(int i = 0; i< getListSize(documents); i++) { + map.put("documents[" + i + "]", getFromList(documents, i)); + } + } + else { + map.put("documents", JSON.getDefault().getMapper().writeValueAsString(documents)); + } + } + if (accounts != null) { + if (isFileTypeOrListOfFiles(accounts)) { + fileTypeFound = true; + } + + if (accounts.getClass().equals(java.io.File.class) || + accounts.getClass().equals(Integer.class) || + accounts.getClass().equals(String.class) || + accounts.getClass().isEnum()) { + map.put("accounts", accounts); + } else if (isListOfFile(accounts)) { + for(int i = 0; i< getListSize(accounts); i++) { + map.put("accounts[" + i + "]", getFromList(accounts, i)); + } + } + else { + map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) || + attachments.getClass().equals(Integer.class) || + attachments.getClass().equals(String.class) || + attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for(int i = 0; i< getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } + else { + map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (updatedAt != null) { + if (isFileTypeOrListOfFiles(updatedAt)) { + fileTypeFound = true; + } + + if (updatedAt.getClass().equals(java.io.File.class) || + updatedAt.getClass().equals(Integer.class) || + updatedAt.getClass().equals(String.class) || + updatedAt.getClass().isEnum()) { + map.put("updated_at", updatedAt); + } else if (isListOfFile(updatedAt)) { + for(int i = 0; i< getListSize(updatedAt); i++) { + map.put("updated_at[" + i + "]", getFromList(updatedAt, i)); + } + } + else { + map.put("updated_at", JSON.getDefault().getMapper().writeValueAsString(updatedAt)); + } + } + if (isEmbedded != null) { + if (isFileTypeOrListOfFiles(isEmbedded)) { + fileTypeFound = true; + } + + if (isEmbedded.getClass().equals(java.io.File.class) || + isEmbedded.getClass().equals(Integer.class) || + isEmbedded.getClass().equals(String.class) || + isEmbedded.getClass().isEnum()) { + map.put("is_embedded", isEmbedded); + } else if (isListOfFile(isEmbedded)) { + for(int i = 0; i< getListSize(isEmbedded); i++) { + map.put("is_embedded[" + i + "]", getFromList(isEmbedded, i)); + } + } + else { + map.put("is_embedded", JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); + } + } if (metadata != null) { if (isFileTypeOrListOfFiles(metadata)) { fileTypeFound = true; @@ -826,25 +923,6 @@ public Map createFormData() throws ApiException { map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); } } - if (documents != null) { - if (isFileTypeOrListOfFiles(documents)) { - fileTypeFound = true; - } - - if (documents.getClass().equals(java.io.File.class) || - documents.getClass().equals(Integer.class) || - documents.getClass().equals(String.class) || - documents.getClass().isEnum()) { - map.put("documents", documents); - } else if (isListOfFile(documents)) { - for(int i = 0; i< getListSize(documents); i++) { - map.put("documents[" + i + "]", getFromList(documents, i)); - } - } - else { - map.put("documents", JSON.getDefault().getMapper().writeValueAsString(documents)); - } - } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; @@ -883,25 +961,6 @@ public Map createFormData() throws ApiException { map.put("named_form_fields", JSON.getDefault().getMapper().writeValueAsString(namedFormFields)); } } - if (accounts != null) { - if (isFileTypeOrListOfFiles(accounts)) { - fileTypeFound = true; - } - - if (accounts.getClass().equals(java.io.File.class) || - accounts.getClass().equals(Integer.class) || - accounts.getClass().equals(String.class) || - accounts.getClass().isEnum()) { - map.put("accounts", accounts); - } else if (isListOfFile(accounts)) { - for(int i = 0; i< getListSize(accounts); i++) { - map.put("accounts[" + i + "]", getFromList(accounts, i)); - } - } - else { - map.put("accounts", JSON.getDefault().getMapper().writeValueAsString(accounts)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 53f50dd8a..ae6b9cdc6 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -35,11 +35,11 @@ */ @JsonPropertyOrder({ TemplateResponseAccount.JSON_PROPERTY_ACCOUNT_ID, - TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS, TemplateResponseAccount.JSON_PROPERTY_IS_LOCKED, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HS, TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HF, - TemplateResponseAccount.JSON_PROPERTY_QUOTAS + TemplateResponseAccount.JSON_PROPERTY_QUOTAS, + TemplateResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -47,9 +47,6 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; private String accountId; - public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; - private String emailAddress; - public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; @@ -62,6 +59,9 @@ public class TemplateResponseAccount { public static final String JSON_PROPERTY_QUOTAS = "quotas"; private TemplateResponseAccountQuota quotas; + public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + private String emailAddress; + public TemplateResponseAccount() { } @@ -89,9 +89,9 @@ public TemplateResponseAccount accountId(String accountId) { * The id of the Account. * @return accountId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getAccountId() { return accountId; @@ -99,37 +99,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAccountId(String accountId) { this.accountId = accountId; } - public TemplateResponseAccount emailAddress(String emailAddress) { - this.emailAddress = emailAddress; - return this; - } - - /** - * The email address associated with the Account. - * @return emailAddress - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getEmailAddress() { - return emailAddress; - } - - - @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { - this.emailAddress = emailAddress; - } - - public TemplateResponseAccount isLocked(Boolean isLocked) { this.isLocked = isLocked; return this; @@ -139,9 +114,9 @@ public TemplateResponseAccount isLocked(Boolean isLocked) { * Returns `true` if the user has been locked out of their account by a team admin. * @return isLocked */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsLocked() { return isLocked; @@ -149,7 +124,7 @@ public Boolean getIsLocked() { @JsonProperty(JSON_PROPERTY_IS_LOCKED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } @@ -164,9 +139,9 @@ public TemplateResponseAccount isPaidHs(Boolean isPaidHs) { * Returns `true` if the user has a paid Dropbox Sign account. * @return isPaidHs */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHs() { return isPaidHs; @@ -174,7 +149,7 @@ public Boolean getIsPaidHs() { @JsonProperty(JSON_PROPERTY_IS_PAID_HS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHs(Boolean isPaidHs) { this.isPaidHs = isPaidHs; } @@ -189,9 +164,9 @@ public TemplateResponseAccount isPaidHf(Boolean isPaidHf) { * Returns `true` if the user has a paid HelloFax account. * @return isPaidHf */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsPaidHf() { return isPaidHf; @@ -199,7 +174,7 @@ public Boolean getIsPaidHf() { @JsonProperty(JSON_PROPERTY_IS_PAID_HF) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsPaidHf(Boolean isPaidHf) { this.isPaidHf = isPaidHf; } @@ -214,9 +189,9 @@ public TemplateResponseAccount quotas(TemplateResponseAccountQuota quotas) { * Get quotas * @return quotas */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseAccountQuota getQuotas() { return quotas; @@ -224,12 +199,37 @@ public TemplateResponseAccountQuota getQuotas() { @JsonProperty(JSON_PROPERTY_QUOTAS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setQuotas(TemplateResponseAccountQuota quotas) { this.quotas = quotas; } + public TemplateResponseAccount emailAddress(String emailAddress) { + this.emailAddress = emailAddress; + return this; + } + + /** + * The email address associated with the Account. + * @return emailAddress + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEmailAddress() { + return emailAddress; + } + + + @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEmailAddress(String emailAddress) { + this.emailAddress = emailAddress; + } + + /** * Return true if this TemplateResponseAccount object is equal to o. */ @@ -243,16 +243,16 @@ public boolean equals(Object o) { } TemplateResponseAccount templateResponseAccount = (TemplateResponseAccount) o; return Objects.equals(this.accountId, templateResponseAccount.accountId) && - Objects.equals(this.emailAddress, templateResponseAccount.emailAddress) && Objects.equals(this.isLocked, templateResponseAccount.isLocked) && Objects.equals(this.isPaidHs, templateResponseAccount.isPaidHs) && Objects.equals(this.isPaidHf, templateResponseAccount.isPaidHf) && - Objects.equals(this.quotas, templateResponseAccount.quotas); + Objects.equals(this.quotas, templateResponseAccount.quotas) && + Objects.equals(this.emailAddress, templateResponseAccount.emailAddress); } @Override public int hashCode() { - return Objects.hash(accountId, emailAddress, isLocked, isPaidHs, isPaidHf, quotas); + return Objects.hash(accountId, isLocked, isPaidHs, isPaidHf, quotas, emailAddress); } @Override @@ -260,11 +260,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseAccount {\n"); sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); - sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); sb.append(" isPaidHs: ").append(toIndentedString(isPaidHs)).append("\n"); sb.append(" isPaidHf: ").append(toIndentedString(isPaidHf)).append("\n"); sb.append(" quotas: ").append(toIndentedString(quotas)).append("\n"); + sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n"); sb.append("}"); return sb.toString(); } @@ -292,25 +292,6 @@ public Map createFormData() throws ApiException { map.put("account_id", JSON.getDefault().getMapper().writeValueAsString(accountId)); } } - if (emailAddress != null) { - if (isFileTypeOrListOfFiles(emailAddress)) { - fileTypeFound = true; - } - - if (emailAddress.getClass().equals(java.io.File.class) || - emailAddress.getClass().equals(Integer.class) || - emailAddress.getClass().equals(String.class) || - emailAddress.getClass().isEnum()) { - map.put("email_address", emailAddress); - } else if (isListOfFile(emailAddress)) { - for(int i = 0; i< getListSize(emailAddress); i++) { - map.put("email_address[" + i + "]", getFromList(emailAddress, i)); - } - } - else { - map.put("email_address", JSON.getDefault().getMapper().writeValueAsString(emailAddress)); - } - } if (isLocked != null) { if (isFileTypeOrListOfFiles(isLocked)) { fileTypeFound = true; @@ -387,6 +368,25 @@ public Map createFormData() throws ApiException { map.put("quotas", JSON.getDefault().getMapper().writeValueAsString(quotas)); } } + if (emailAddress != null) { + if (isFileTypeOrListOfFiles(emailAddress)) { + fileTypeFound = true; + } + + if (emailAddress.getClass().equals(java.io.File.class) || + emailAddress.getClass().equals(Integer.class) || + emailAddress.getClass().equals(String.class) || + emailAddress.getClass().isEnum()) { + map.put("email_address", emailAddress); + } else if (isListOfFile(emailAddress)) { + for(int i = 0; i< getListSize(emailAddress); i++) { + map.put("email_address[" + i + "]", getFromList(emailAddress, i)); + } + } + else { + map.put("email_address", JSON.getDefault().getMapper().writeValueAsString(emailAddress)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 78b1f583d..0b1e7e66f 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -80,9 +80,9 @@ public TemplateResponseAccountQuota templatesLeft(Integer templatesLeft) { * API templates remaining. * @return templatesLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getTemplatesLeft() { return templatesLeft; @@ -90,7 +90,7 @@ public Integer getTemplatesLeft() { @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplatesLeft(Integer templatesLeft) { this.templatesLeft = templatesLeft; } @@ -105,9 +105,9 @@ public TemplateResponseAccountQuota apiSignatureRequestsLeft(Integer apiSignatur * API signature requests remaining. * @return apiSignatureRequestsLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getApiSignatureRequestsLeft() { return apiSignatureRequestsLeft; @@ -115,7 +115,7 @@ public Integer getApiSignatureRequestsLeft() { @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } @@ -130,9 +130,9 @@ public TemplateResponseAccountQuota documentsLeft(Integer documentsLeft) { * Signature requests remaining. * @return documentsLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getDocumentsLeft() { return documentsLeft; @@ -140,7 +140,7 @@ public Integer getDocumentsLeft() { @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setDocumentsLeft(Integer documentsLeft) { this.documentsLeft = documentsLeft; } @@ -155,9 +155,9 @@ public TemplateResponseAccountQuota smsVerificationsLeft(Integer smsVerification * SMS verifications remaining. * @return smsVerificationsLeft */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getSmsVerificationsLeft() { return smsVerificationsLeft; @@ -165,7 +165,7 @@ public Integer getSmsVerificationsLeft() { @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index 4ed3eb946..5a9461f44 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -68,9 +68,9 @@ public TemplateResponseCCRole name(String name) { * The name of the Role. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -78,7 +78,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index 040c68ccc..2dbcbfee0 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -40,11 +40,11 @@ */ @JsonPropertyOrder({ TemplateResponseDocument.JSON_PROPERTY_NAME, - TemplateResponseDocument.JSON_PROPERTY_INDEX, TemplateResponseDocument.JSON_PROPERTY_FIELD_GROUPS, TemplateResponseDocument.JSON_PROPERTY_FORM_FIELDS, TemplateResponseDocument.JSON_PROPERTY_CUSTOM_FIELDS, - TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS + TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS, + TemplateResponseDocument.JSON_PROPERTY_INDEX }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -52,20 +52,20 @@ public class TemplateResponseDocument { public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_INDEX = "index"; - private Integer index; - public static final String JSON_PROPERTY_FIELD_GROUPS = "field_groups"; - private List fieldGroups = null; + private List fieldGroups = new ArrayList<>(); public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; - private List formFields = null; + private List formFields = new ArrayList<>(); public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; - private List customFields = null; + private List customFields = new ArrayList<>(); public static final String JSON_PROPERTY_STATIC_FIELDS = "static_fields"; - private List staticFields = null; + private List staticFields = new ArrayList<>(); + + public static final String JSON_PROPERTY_INDEX = "index"; + private Integer index; public TemplateResponseDocument() { } @@ -94,9 +94,9 @@ public TemplateResponseDocument name(String name) { * Name of the associated file. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -104,37 +104,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocument index(Integer index) { - this.index = index; - return this; - } - - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - * @return index - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Integer getIndex() { - return index; - } - - - @JsonProperty(JSON_PROPERTY_INDEX) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIndex(Integer index) { - this.index = index; - } - - public TemplateResponseDocument fieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; return this; @@ -152,9 +127,9 @@ public TemplateResponseDocument addFieldGroupsItem(TemplateResponseDocumentField * An array of Form Field Group objects. * @return fieldGroups */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFieldGroups() { return fieldGroups; @@ -162,7 +137,7 @@ public List getFieldGroups() { @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFieldGroups(List fieldGroups) { this.fieldGroups = fieldGroups; } @@ -185,9 +160,9 @@ public TemplateResponseDocument addFormFieldsItem(TemplateResponseDocumentFormFi * An array of Form Field objects containing the name and type of each named field. * @return formFields */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getFormFields() { return formFields; @@ -195,7 +170,7 @@ public List getFormFields() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFormFields(List formFields) { this.formFields = formFields; } @@ -218,9 +193,9 @@ public TemplateResponseDocument addCustomFieldsItem(TemplateResponseDocumentCust * An array of Form Field objects containing the name and type of each named field. * @return customFields */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getCustomFields() { return customFields; @@ -228,7 +203,7 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setCustomFields(List customFields) { this.customFields = customFields; } @@ -251,9 +226,9 @@ public TemplateResponseDocument addStaticFieldsItem(TemplateResponseDocumentStat * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * @return staticFields */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public List getStaticFields() { return staticFields; @@ -261,12 +236,37 @@ public List getStaticFields() { @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setStaticFields(List staticFields) { this.staticFields = staticFields; } + public TemplateResponseDocument index(Integer index) { + this.index = index; + return this; + } + + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + * @return index + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getIndex() { + return index; + } + + + @JsonProperty(JSON_PROPERTY_INDEX) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIndex(Integer index) { + this.index = index; + } + + /** * Return true if this TemplateResponseDocument object is equal to o. */ @@ -280,16 +280,16 @@ public boolean equals(Object o) { } TemplateResponseDocument templateResponseDocument = (TemplateResponseDocument) o; return Objects.equals(this.name, templateResponseDocument.name) && - Objects.equals(this.index, templateResponseDocument.index) && Objects.equals(this.fieldGroups, templateResponseDocument.fieldGroups) && Objects.equals(this.formFields, templateResponseDocument.formFields) && Objects.equals(this.customFields, templateResponseDocument.customFields) && - Objects.equals(this.staticFields, templateResponseDocument.staticFields); + Objects.equals(this.staticFields, templateResponseDocument.staticFields) && + Objects.equals(this.index, templateResponseDocument.index); } @Override public int hashCode() { - return Objects.hash(name, index, fieldGroups, formFields, customFields, staticFields); + return Objects.hash(name, fieldGroups, formFields, customFields, staticFields, index); } @Override @@ -297,11 +297,11 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocument {\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append(" fieldGroups: ").append(toIndentedString(fieldGroups)).append("\n"); sb.append(" formFields: ").append(toIndentedString(formFields)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" staticFields: ").append(toIndentedString(staticFields)).append("\n"); + sb.append(" index: ").append(toIndentedString(index)).append("\n"); sb.append("}"); return sb.toString(); } @@ -329,25 +329,6 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (index != null) { - if (isFileTypeOrListOfFiles(index)) { - fileTypeFound = true; - } - - if (index.getClass().equals(java.io.File.class) || - index.getClass().equals(Integer.class) || - index.getClass().equals(String.class) || - index.getClass().isEnum()) { - map.put("index", index); - } else if (isListOfFile(index)) { - for(int i = 0; i< getListSize(index); i++) { - map.put("index[" + i + "]", getFromList(index, i)); - } - } - else { - map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); - } - } if (fieldGroups != null) { if (isFileTypeOrListOfFiles(fieldGroups)) { fileTypeFound = true; @@ -424,6 +405,25 @@ public Map createFormData() throws ApiException { map.put("static_fields", JSON.getDefault().getMapper().writeValueAsString(staticFields)); } } + if (index != null) { + if (isFileTypeOrListOfFiles(index)) { + fileTypeFound = true; + } + + if (index.getClass().equals(java.io.File.class) || + index.getClass().equals(Integer.class) || + index.getClass().equals(String.class) || + index.getClass().isEnum()) { + map.put("index", index); + } else if (isListOfFile(index)) { + for(int i = 0; i< getListSize(index); i++) { + map.put("index[" + i + "]", getFromList(index, i)); + } + } + else { + map.put("index", JSON.getDefault().getMapper().writeValueAsString(index)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index 4797afd91..e5cf7fa77 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -36,15 +36,15 @@ * An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_NAME, - TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_HEIGHT, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_REQUIRED, + TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @@ -59,17 +59,14 @@ }) public class TemplateResponseDocumentCustomFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; - public static final String JSON_PROPERTY_SIGNER = "signer"; - private String signer; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; public static final String JSON_PROPERTY_X = "x"; private Integer x; @@ -86,6 +83,9 @@ public class TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; + public static final String JSON_PROPERTY_SIGNER = "signer"; + private String signer; + public static final String JSON_PROPERTY_GROUP = "group"; private String group; @@ -107,31 +107,6 @@ static public TemplateResponseDocumentCustomFieldBase init(HashMap data) throws ); } - public TemplateResponseDocumentCustomFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -141,9 +116,9 @@ public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { * The unique ID for this field. * @return apiId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; @@ -151,7 +126,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -166,9 +141,9 @@ public TemplateResponseDocumentCustomFieldBase name(String name) { * The name of the Custom Field. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -176,42 +151,34 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } - public TemplateResponseDocumentCustomFieldBase signer(String signer) { - this.signer = signer; - return this; - } - public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { - this.signer = String.valueOf(signer); + public TemplateResponseDocumentCustomFieldBase type(String type) { + this.type = type; return this; } /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - * @return signer + * Get type + * @return type */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) - public String getSigner() { - return signer; + public String getType() { + return type; } - @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { - this.signer = signer; - } - - public void setSigner(Integer signer) { - this.signer = String.valueOf(signer); + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; } @@ -224,9 +191,9 @@ public TemplateResponseDocumentCustomFieldBase x(Integer x) { * The horizontal offset in pixels for this form field. * @return x */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; @@ -234,7 +201,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -249,9 +216,9 @@ public TemplateResponseDocumentCustomFieldBase y(Integer y) { * The vertical offset in pixels for this form field. * @return y */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; @@ -259,7 +226,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -274,9 +241,9 @@ public TemplateResponseDocumentCustomFieldBase width(Integer width) { * The width in pixels of this form field. * @return width */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; @@ -284,7 +251,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -299,9 +266,9 @@ public TemplateResponseDocumentCustomFieldBase height(Integer height) { * The height in pixels of this form field. * @return height */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; @@ -309,7 +276,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -324,9 +291,9 @@ public TemplateResponseDocumentCustomFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; @@ -334,12 +301,45 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } + public TemplateResponseDocumentCustomFieldBase signer(String signer) { + this.signer = signer; + return this; + } + public TemplateResponseDocumentCustomFieldBase signer(Integer signer) { + this.signer = String.valueOf(signer); + return this; + } + + /** + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * @return signer + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSigner() { + return signer; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigner(String signer) { + this.signer = signer; + } + + public void setSigner(Integer signer) { + this.signer = String.valueOf(signer); + } + + public TemplateResponseDocumentCustomFieldBase group(String group) { this.group = group; return this; @@ -377,36 +377,36 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentCustomFieldBase templateResponseDocumentCustomFieldBase = (TemplateResponseDocumentCustomFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && - Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && + return Objects.equals(this.apiId, templateResponseDocumentCustomFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentCustomFieldBase.name) && - Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && + Objects.equals(this.type, templateResponseDocumentCustomFieldBase.type) && Objects.equals(this.x, templateResponseDocumentCustomFieldBase.x) && Objects.equals(this.y, templateResponseDocumentCustomFieldBase.y) && Objects.equals(this.width, templateResponseDocumentCustomFieldBase.width) && Objects.equals(this.height, templateResponseDocumentCustomFieldBase.height) && Objects.equals(this.required, templateResponseDocumentCustomFieldBase.required) && + Objects.equals(this.signer, templateResponseDocumentCustomFieldBase.signer) && Objects.equals(this.group, templateResponseDocumentCustomFieldBase.group); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, x, y, width, height, required, signer, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentCustomFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); + sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); @@ -416,25 +416,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -473,23 +454,23 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } - if (signer != null) { - if (isFileTypeOrListOfFiles(signer)) { + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { fileTypeFound = true; } - if (signer.getClass().equals(java.io.File.class) || - signer.getClass().equals(Integer.class) || - signer.getClass().equals(String.class) || - signer.getClass().isEnum()) { - map.put("signer", signer); - } else if (isListOfFile(signer)) { - for(int i = 0; i< getListSize(signer); i++) { - map.put("signer[" + i + "]", getFromList(signer, i)); + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); } } else { - map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } if (x != null) { @@ -587,6 +568,25 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } + if (signer != null) { + if (isFileTypeOrListOfFiles(signer)) { + fileTypeFound = true; + } + + if (signer.getClass().equals(java.io.File.class) || + signer.getClass().equals(Integer.class) || + signer.getClass().equals(String.class) || + signer.getClass().isEnum()) { + map.put("signer", signer); + } else if (isListOfFile(signer)) { + for(int i = 0; i< getListSize(signer); i++) { + map.put("signer[" + i + "]", getFromList(signer, i)); + } + } + else { + map.put("signer", JSON.getDefault().getMapper().writeValueAsString(signer)); + } + } if (group != null) { if (isFileTypeOrListOfFiles(group)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index e9c2932d6..5aba1a567 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -119,9 +119,9 @@ public TemplateResponseDocumentCustomFieldText avgTextLength(TemplateResponseFie * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -129,7 +129,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -144,9 +144,9 @@ public TemplateResponseDocumentCustomFieldText isMultiline(Boolean isMultiline) * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; @@ -154,7 +154,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -169,9 +169,9 @@ public TemplateResponseDocumentCustomFieldText originalFontSize(Integer original * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; @@ -179,7 +179,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -194,9 +194,9 @@ public TemplateResponseDocumentCustomFieldText fontFamily(String fontFamily) { * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; @@ -204,7 +204,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index 3e724af45..d02f5f5ec 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -73,9 +73,9 @@ public TemplateResponseDocumentFieldGroup name(String name) { * The name of the form field group. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -83,7 +83,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } @@ -98,9 +98,9 @@ public TemplateResponseDocumentFieldGroup rule(TemplateResponseDocumentFieldGrou * Get rule * @return rule */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseDocumentFieldGroupRule getRule() { return rule; @@ -108,7 +108,7 @@ public TemplateResponseDocumentFieldGroupRule getRule() { @JsonProperty(JSON_PROPERTY_RULE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRule(TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index 65aa63b0f..d92998793 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -72,9 +72,9 @@ public TemplateResponseDocumentFieldGroupRule requirement(String requirement) { * Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. * @return requirement */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getRequirement() { return requirement; @@ -82,7 +82,7 @@ public String getRequirement() { @JsonProperty(JSON_PROPERTY_REQUIREMENT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequirement(String requirement) { this.requirement = requirement; } @@ -97,9 +97,9 @@ public TemplateResponseDocumentFieldGroupRule groupLabel(String groupLabel) { * Name of the group * @return groupLabel */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getGroupLabel() { return groupLabel; @@ -107,7 +107,7 @@ public String getGroupLabel() { @JsonProperty(JSON_PROPERTY_GROUP_LABEL) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setGroupLabel(String groupLabel) { this.groupLabel = groupLabel; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index cbef92e0f..5a62be6c8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -36,16 +36,15 @@ * An array of Form Field objects containing the name and type of each named field. */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_Y, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_WIDTH, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_HEIGHT, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED, - TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_GROUP + TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -65,15 +64,15 @@ }) public class TemplateResponseDocumentFormFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer; @@ -92,9 +91,6 @@ public class TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_REQUIRED = "required"; private Boolean required; - public static final String JSON_PROPERTY_GROUP = "group"; - private String group; - public TemplateResponseDocumentFormFieldBase() { } @@ -113,31 +109,6 @@ static public TemplateResponseDocumentFormFieldBase init(HashMap data) throws Ex ); } - public TemplateResponseDocumentFormFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentFormFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -147,9 +118,9 @@ public TemplateResponseDocumentFormFieldBase apiId(String apiId) { * A unique id for the form field. * @return apiId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; @@ -157,7 +128,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -172,9 +143,9 @@ public TemplateResponseDocumentFormFieldBase name(String name) { * The name of the form field. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -182,12 +153,37 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentFormFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + + public TemplateResponseDocumentFormFieldBase signer(String signer) { this.signer = signer; return this; @@ -201,9 +197,9 @@ public TemplateResponseDocumentFormFieldBase signer(Integer signer) { * The signer of the Form Field. * @return signer */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; @@ -211,7 +207,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -230,9 +226,9 @@ public TemplateResponseDocumentFormFieldBase x(Integer x) { * The horizontal offset in pixels for this form field. * @return x */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; @@ -240,7 +236,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -255,9 +251,9 @@ public TemplateResponseDocumentFormFieldBase y(Integer y) { * The vertical offset in pixels for this form field. * @return y */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; @@ -265,7 +261,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -280,9 +276,9 @@ public TemplateResponseDocumentFormFieldBase width(Integer width) { * The width in pixels of this form field. * @return width */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; @@ -290,7 +286,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -305,9 +301,9 @@ public TemplateResponseDocumentFormFieldBase height(Integer height) { * The height in pixels of this form field. * @return height */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; @@ -315,7 +311,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -330,9 +326,9 @@ public TemplateResponseDocumentFormFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; @@ -340,37 +336,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } - public TemplateResponseDocumentFormFieldBase group(String group) { - this.group = group; - return this; - } - - /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - * @return group - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getGroup() { - return group; - } - - - @JsonProperty(JSON_PROPERTY_GROUP) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { - this.group = group; - } - - /** * Return true if this TemplateResponseDocumentFormFieldBase object is equal to o. */ @@ -383,37 +354,35 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentFormFieldBase templateResponseDocumentFormFieldBase = (TemplateResponseDocumentFormFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && - Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && + return Objects.equals(this.apiId, templateResponseDocumentFormFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentFormFieldBase.name) && + Objects.equals(this.type, templateResponseDocumentFormFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentFormFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentFormFieldBase.x) && Objects.equals(this.y, templateResponseDocumentFormFieldBase.y) && Objects.equals(this.width, templateResponseDocumentFormFieldBase.width) && Objects.equals(this.height, templateResponseDocumentFormFieldBase.height) && - Objects.equals(this.required, templateResponseDocumentFormFieldBase.required) && - Objects.equals(this.group, templateResponseDocumentFormFieldBase.group); + Objects.equals(this.required, templateResponseDocumentFormFieldBase.required); } @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentFormFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); sb.append(" width: ").append(toIndentedString(width)).append("\n"); sb.append(" height: ").append(toIndentedString(height)).append("\n"); sb.append(" required: ").append(toIndentedString(required)).append("\n"); - sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -422,25 +391,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -479,6 +429,25 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } + else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; @@ -593,25 +562,6 @@ public Map createFormData() throws ApiException { map.put("required", JSON.getDefault().getMapper().writeValueAsString(required)); } } - if (group != null) { - if (isFileTypeOrListOfFiles(group)) { - fileTypeFound = true; - } - - if (group.getClass().equals(java.io.File.class) || - group.getClass().equals(Integer.class) || - group.getClass().equals(String.class) || - group.getClass().isEnum()) { - map.put("group", group); - } else if (isListOfFile(group)) { - for(int i = 0; i< getListSize(group); i++) { - map.put("group[" + i + "]", getFromList(group, i)); - } - } - else { - map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); - } - } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java index 8354a7a23..110468a28 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD public static final String JSON_PROPERTY_TYPE = "type"; private String type = "checkbox"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldCheckbox() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldCheckbox group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldCheckbox object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldCheckbox templateResponseDocumentFormFieldCheckbox = (TemplateResponseDocumentFormFieldCheckbox) o; return Objects.equals(this.type, templateResponseDocumentFormFieldCheckbox.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldCheckbox.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldCheckbox {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java index 202991168..67ec89a5c 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons public static final String JSON_PROPERTY_TYPE = "type"; private String type = "date_signed"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDateSigned() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldDateSigned group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldDateSigned object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldDateSigned templateResponseDocumentFormFieldDateSigned = (TemplateResponseDocumentFormFieldDateSigned) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDateSigned.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldDateSigned.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDateSigned {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java index ca033ad09..8003f4c05 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD public static final String JSON_PROPERTY_TYPE = "type"; private String type = "dropdown"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldDropdown() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldDropdown group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldDropdown object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldDropdown templateResponseDocumentFormFieldDropdown = (TemplateResponseDocumentFormFieldDropdown) o; return Objects.equals(this.type, templateResponseDocumentFormFieldDropdown.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldDropdown.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldDropdown {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index acaa254b4..3db1348fb 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -42,7 +42,8 @@ TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_AVG_TEXT_LENGTH, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_ORIGINAL_FONT_SIZE, - TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY, + TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -67,6 +68,9 @@ public class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; private String fontFamily; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldHyperlink() { } @@ -119,9 +123,9 @@ public TemplateResponseDocumentFormFieldHyperlink avgTextLength(TemplateResponse * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -129,7 +133,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -144,9 +148,9 @@ public TemplateResponseDocumentFormFieldHyperlink isMultiline(Boolean isMultilin * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; @@ -154,7 +158,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -169,9 +173,9 @@ public TemplateResponseDocumentFormFieldHyperlink originalFontSize(Integer origi * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; @@ -179,7 +183,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -194,9 +198,9 @@ public TemplateResponseDocumentFormFieldHyperlink fontFamily(String fontFamily) * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; @@ -204,12 +208,37 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } + public TemplateResponseDocumentFormFieldHyperlink group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldHyperlink object is equal to o. */ @@ -227,12 +256,13 @@ public boolean equals(Object o) { Objects.equals(this.isMultiline, templateResponseDocumentFormFieldHyperlink.isMultiline) && Objects.equals(this.originalFontSize, templateResponseDocumentFormFieldHyperlink.originalFontSize) && Objects.equals(this.fontFamily, templateResponseDocumentFormFieldHyperlink.fontFamily) && + Objects.equals(this.group, templateResponseDocumentFormFieldHyperlink.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, super.hashCode()); + return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, group, super.hashCode()); } @Override @@ -245,6 +275,7 @@ public String toString() { sb.append(" isMultiline: ").append(toIndentedString(isMultiline)).append("\n"); sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -349,6 +380,25 @@ public Map createFormData() throws ApiException { map.put("fontFamily", JSON.getDefault().getMapper().writeValueAsString(fontFamily)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java index 749d70157..7aa96f533 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD public static final String JSON_PROPERTY_TYPE = "type"; private String type = "initials"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldInitials() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldInitials group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldInitials object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldInitials templateResponseDocumentFormFieldInitials = (TemplateResponseDocumentFormFieldInitials) o; return Objects.equals(this.type, templateResponseDocumentFormFieldInitials.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldInitials.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldInitials {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java index aa71ef521..5e9365793 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu public static final String JSON_PROPERTY_TYPE = "type"; private String type = "radio"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldRadio() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldRadio group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldRadio object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldRadio templateResponseDocumentFormFieldRadio = (TemplateResponseDocumentFormFieldRadio) o; return Objects.equals(this.type, templateResponseDocumentFormFieldRadio.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldRadio.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldRadio {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java index 9ff154afe..ac0a0c321 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java @@ -37,7 +37,8 @@ * This class extends `TemplateResponseDocumentFormFieldBase` */ @JsonPropertyOrder({ - TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE, + TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -50,6 +51,9 @@ public class TemplateResponseDocumentFormFieldSignature extends TemplateResponse public static final String JSON_PROPERTY_TYPE = "type"; private String type = "signature"; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldSignature() { } @@ -93,6 +97,31 @@ public void setType(String type) { } + public TemplateResponseDocumentFormFieldSignature group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldSignature object is equal to o. */ @@ -106,12 +135,13 @@ public boolean equals(Object o) { } TemplateResponseDocumentFormFieldSignature templateResponseDocumentFormFieldSignature = (TemplateResponseDocumentFormFieldSignature) o; return Objects.equals(this.type, templateResponseDocumentFormFieldSignature.type) && + Objects.equals(this.group, templateResponseDocumentFormFieldSignature.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, super.hashCode()); + return Objects.hash(type, group, super.hashCode()); } @Override @@ -120,6 +150,7 @@ public String toString() { sb.append("class TemplateResponseDocumentFormFieldSignature {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -148,6 +179,25 @@ public Map createFormData() throws ApiException { map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index db2192813..2474e5298 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -43,7 +43,8 @@ TemplateResponseDocumentFormFieldText.JSON_PROPERTY_IS_MULTILINE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_ORIGINAL_FONT_SIZE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_FONT_FAMILY, - TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE, + TemplateResponseDocumentFormFieldText.JSON_PROPERTY_GROUP }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties( @@ -122,6 +123,9 @@ public static ValidationTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_VALIDATION_TYPE = "validation_type"; private ValidationTypeEnum validationType; + public static final String JSON_PROPERTY_GROUP = "group"; + private String group; + public TemplateResponseDocumentFormFieldText() { } @@ -174,9 +178,9 @@ public TemplateResponseDocumentFormFieldText avgTextLength(TemplateResponseField * Get avgTextLength * @return avgTextLength */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public TemplateResponseFieldAvgTextLength getAvgTextLength() { return avgTextLength; @@ -184,7 +188,7 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } @@ -199,9 +203,9 @@ public TemplateResponseDocumentFormFieldText isMultiline(Boolean isMultiline) { * Whether this form field is multiline text. * @return isMultiline */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getIsMultiline() { return isMultiline; @@ -209,7 +213,7 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setIsMultiline(Boolean isMultiline) { this.isMultiline = isMultiline; } @@ -224,9 +228,9 @@ public TemplateResponseDocumentFormFieldText originalFontSize(Integer originalFo * Original font size used in this form field's text. * @return originalFontSize */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getOriginalFontSize() { return originalFontSize; @@ -234,7 +238,7 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setOriginalFontSize(Integer originalFontSize) { this.originalFontSize = originalFontSize; } @@ -249,9 +253,9 @@ public TemplateResponseDocumentFormFieldText fontFamily(String fontFamily) { * Font family used in this form field's text. * @return fontFamily */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getFontFamily() { return fontFamily; @@ -259,7 +263,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setFontFamily(String fontFamily) { this.fontFamily = fontFamily; } @@ -290,6 +294,31 @@ public void setValidationType(ValidationTypeEnum validationType) { } + public TemplateResponseDocumentFormFieldText group(String group) { + this.group = group; + return this; + } + + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * @return group + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGroup() { + return group; + } + + + @JsonProperty(JSON_PROPERTY_GROUP) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroup(String group) { + this.group = group; + } + + /** * Return true if this TemplateResponseDocumentFormFieldText object is equal to o. */ @@ -308,12 +337,13 @@ public boolean equals(Object o) { Objects.equals(this.originalFontSize, templateResponseDocumentFormFieldText.originalFontSize) && Objects.equals(this.fontFamily, templateResponseDocumentFormFieldText.fontFamily) && Objects.equals(this.validationType, templateResponseDocumentFormFieldText.validationType) && + Objects.equals(this.group, templateResponseDocumentFormFieldText.group) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, validationType, super.hashCode()); + return Objects.hash(type, avgTextLength, isMultiline, originalFontSize, fontFamily, validationType, group, super.hashCode()); } @Override @@ -327,6 +357,7 @@ public String toString() { sb.append(" originalFontSize: ").append(toIndentedString(originalFontSize)).append("\n"); sb.append(" fontFamily: ").append(toIndentedString(fontFamily)).append("\n"); sb.append(" validationType: ").append(toIndentedString(validationType)).append("\n"); + sb.append(" group: ").append(toIndentedString(group)).append("\n"); sb.append("}"); return sb.toString(); } @@ -450,6 +481,25 @@ public Map createFormData() throws ApiException { map.put("validation_type", JSON.getDefault().getMapper().writeValueAsString(validationType)); } } + if (group != null) { + if (isFileTypeOrListOfFiles(group)) { + fileTypeFound = true; + } + + if (group.getClass().equals(java.io.File.class) || + group.getClass().equals(Integer.class) || + group.getClass().equals(String.class) || + group.getClass().isEnum()) { + map.put("group", group); + } else if (isListOfFile(group)) { + for(int i = 0; i< getListSize(group); i++) { + map.put("group[" + i + "]", getFromList(group, i)); + } + } + else { + map.put("group", JSON.getDefault().getMapper().writeValueAsString(group)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 4e1e98229..96a4e8d85 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -36,9 +36,9 @@ * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ @JsonPropertyOrder({ - TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_API_ID, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_NAME, + TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_TYPE, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_SIGNER, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_X, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_Y, @@ -65,15 +65,15 @@ }) public class TemplateResponseDocumentStaticFieldBase { - public static final String JSON_PROPERTY_TYPE = "type"; - private String type; - public static final String JSON_PROPERTY_API_ID = "api_id"; private String apiId; public static final String JSON_PROPERTY_NAME = "name"; private String name; + public static final String JSON_PROPERTY_TYPE = "type"; + private String type; + public static final String JSON_PROPERTY_SIGNER = "signer"; private String signer = "me_now"; @@ -113,31 +113,6 @@ static public TemplateResponseDocumentStaticFieldBase init(HashMap data) throws ); } - public TemplateResponseDocumentStaticFieldBase type(String type) { - this.type = type; - return this; - } - - /** - * Get type - * @return type - */ - @jakarta.annotation.Nonnull - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - - public String getType() { - return type; - } - - - @JsonProperty(JSON_PROPERTY_TYPE) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { - this.type = type; - } - - public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { this.apiId = apiId; return this; @@ -147,9 +122,9 @@ public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { * A unique id for the static field. * @return apiId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getApiId() { return apiId; @@ -157,7 +132,7 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setApiId(String apiId) { this.apiId = apiId; } @@ -172,9 +147,9 @@ public TemplateResponseDocumentStaticFieldBase name(String name) { * The name of the static field. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -182,12 +157,37 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } + public TemplateResponseDocumentStaticFieldBase type(String type) { + this.type = type; + return this; + } + + /** + * Get type + * @return type + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getType() { + return type; + } + + + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setType(String type) { + this.type = type; + } + + public TemplateResponseDocumentStaticFieldBase signer(String signer) { this.signer = signer; return this; @@ -197,9 +197,9 @@ public TemplateResponseDocumentStaticFieldBase signer(String signer) { * The signer of the Static Field. * @return signer */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getSigner() { return signer; @@ -207,7 +207,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setSigner(String signer) { this.signer = signer; } @@ -222,9 +222,9 @@ public TemplateResponseDocumentStaticFieldBase x(Integer x) { * The horizontal offset in pixels for this static field. * @return x */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getX() { return x; @@ -232,7 +232,7 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setX(Integer x) { this.x = x; } @@ -247,9 +247,9 @@ public TemplateResponseDocumentStaticFieldBase y(Integer y) { * The vertical offset in pixels for this static field. * @return y */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getY() { return y; @@ -257,7 +257,7 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setY(Integer y) { this.y = y; } @@ -272,9 +272,9 @@ public TemplateResponseDocumentStaticFieldBase width(Integer width) { * The width in pixels of this static field. * @return width */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getWidth() { return width; @@ -282,7 +282,7 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setWidth(Integer width) { this.width = width; } @@ -297,9 +297,9 @@ public TemplateResponseDocumentStaticFieldBase height(Integer height) { * The height in pixels of this static field. * @return height */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getHeight() { return height; @@ -307,7 +307,7 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setHeight(Integer height) { this.height = height; } @@ -322,9 +322,9 @@ public TemplateResponseDocumentStaticFieldBase required(Boolean required) { * Boolean showing whether or not this field is required. * @return required */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Boolean getRequired() { return required; @@ -332,7 +332,7 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setRequired(Boolean required) { this.required = required; } @@ -375,9 +375,9 @@ public boolean equals(Object o) { return false; } TemplateResponseDocumentStaticFieldBase templateResponseDocumentStaticFieldBase = (TemplateResponseDocumentStaticFieldBase) o; - return Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && - Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && + return Objects.equals(this.apiId, templateResponseDocumentStaticFieldBase.apiId) && Objects.equals(this.name, templateResponseDocumentStaticFieldBase.name) && + Objects.equals(this.type, templateResponseDocumentStaticFieldBase.type) && Objects.equals(this.signer, templateResponseDocumentStaticFieldBase.signer) && Objects.equals(this.x, templateResponseDocumentStaticFieldBase.x) && Objects.equals(this.y, templateResponseDocumentStaticFieldBase.y) && @@ -389,16 +389,16 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(type, apiId, name, signer, x, y, width, height, required, group); + return Objects.hash(apiId, name, type, signer, x, y, width, height, required, group); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TemplateResponseDocumentStaticFieldBase {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" apiId: ").append(toIndentedString(apiId)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" signer: ").append(toIndentedString(signer)).append("\n"); sb.append(" x: ").append(toIndentedString(x)).append("\n"); sb.append(" y: ").append(toIndentedString(y)).append("\n"); @@ -414,25 +414,6 @@ public Map createFormData() throws ApiException { Map map = new HashMap<>(); boolean fileTypeFound = false; try { - if (type != null) { - if (isFileTypeOrListOfFiles(type)) { - fileTypeFound = true; - } - - if (type.getClass().equals(java.io.File.class) || - type.getClass().equals(Integer.class) || - type.getClass().equals(String.class) || - type.getClass().isEnum()) { - map.put("type", type); - } else if (isListOfFile(type)) { - for(int i = 0; i< getListSize(type); i++) { - map.put("type[" + i + "]", getFromList(type, i)); - } - } - else { - map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); - } - } if (apiId != null) { if (isFileTypeOrListOfFiles(apiId)) { fileTypeFound = true; @@ -471,6 +452,25 @@ public Map createFormData() throws ApiException { map.put("name", JSON.getDefault().getMapper().writeValueAsString(name)); } } + if (type != null) { + if (isFileTypeOrListOfFiles(type)) { + fileTypeFound = true; + } + + if (type.getClass().equals(java.io.File.class) || + type.getClass().equals(Integer.class) || + type.getClass().equals(String.class) || + type.getClass().isEnum()) { + map.put("type", type); + } else if (isListOfFile(type)) { + for(int i = 0; i< getListSize(type); i++) { + map.put("type[" + i + "]", getFromList(type, i)); + } + } + else { + map.put("type", JSON.getDefault().getMapper().writeValueAsString(type)); + } + } if (signer != null) { if (isFileTypeOrListOfFiles(signer)) { fileTypeFound = true; diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index 38f5acd25..fc46699ac 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -72,9 +72,9 @@ public TemplateResponseFieldAvgTextLength numLines(Integer numLines) { * Number of lines. * @return numLines */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumLines() { return numLines; @@ -82,7 +82,7 @@ public Integer getNumLines() { @JsonProperty(JSON_PROPERTY_NUM_LINES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumLines(Integer numLines) { this.numLines = numLines; } @@ -97,9 +97,9 @@ public TemplateResponseFieldAvgTextLength numCharsPerLine(Integer numCharsPerLin * Number of characters per line. * @return numCharsPerLine */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public Integer getNumCharsPerLine() { return numCharsPerLine; @@ -107,7 +107,7 @@ public Integer getNumCharsPerLine() { @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setNumCharsPerLine(Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index 45d786a89..d1463cbd8 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -72,9 +72,9 @@ public TemplateResponseSignerRole name(String name) { * The name of the Role. * @return name */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getName() { return name; @@ -82,7 +82,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setName(String name) { this.name = name; } diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 19dea91bd..fb4c17ded 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -76,9 +76,9 @@ public TemplateUpdateFilesResponseTemplate templateId(String templateId) { * The id of the Template. * @return templateId */ - @jakarta.annotation.Nullable + @jakarta.annotation.Nonnull @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public String getTemplateId() { return templateId; @@ -86,7 +86,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) public void setTemplateId(String templateId) { this.templateId = templateId; } diff --git a/sdks/node/api/oAuthApi.ts b/sdks/node/api/oAuthApi.ts index 1478d53e0..c1b080359 100644 --- a/sdks/node/api/oAuthApi.ts +++ b/sdks/node/api/oAuthApi.ts @@ -236,17 +236,6 @@ export class OAuthApi { return; } - if ( - handleErrorRangeResponse( - reject, - error.response, - "4XX", - "ErrorResponse" - ) - ) { - return; - } - reject(error); } ); @@ -372,17 +361,6 @@ export class OAuthApi { return; } - if ( - handleErrorRangeResponse( - reject, - error.response, - "4XX", - "ErrorResponse" - ) - ) { - return; - } - reject(error); } ); diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index d95c19e31..8c6997d8f 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -18331,16 +18331,6 @@ OAuthTokenRefreshRequest.attributeTypeMap = [ name: "refreshToken", baseName: "refresh_token", type: "string" - }, - { - name: "clientId", - baseName: "client_id", - type: "string" - }, - { - name: "clientSecret", - baseName: "client_secret", - type: "string" } ]; @@ -22503,16 +22493,6 @@ TemplateResponse.attributeTypeMap = [ baseName: "message", type: "string" }, - { - name: "updatedAt", - baseName: "updated_at", - type: "number" - }, - { - name: "isEmbedded", - baseName: "is_embedded", - type: "boolean" - }, { name: "isCreator", baseName: "is_creator", @@ -22528,6 +22508,31 @@ TemplateResponse.attributeTypeMap = [ baseName: "is_locked", type: "boolean" }, + { + name: "documents", + baseName: "documents", + type: "Array" + }, + { + name: "accounts", + baseName: "accounts", + type: "Array" + }, + { + name: "attachments", + baseName: "attachments", + type: "Array" + }, + { + name: "updatedAt", + baseName: "updated_at", + type: "number" + }, + { + name: "isEmbedded", + baseName: "is_embedded", + type: "boolean" + }, { name: "metadata", baseName: "metadata", @@ -22543,11 +22548,6 @@ TemplateResponse.attributeTypeMap = [ baseName: "cc_roles", type: "Array" }, - { - name: "documents", - baseName: "documents", - type: "Array" - }, { name: "customFields", baseName: "custom_fields", @@ -22557,11 +22557,6 @@ TemplateResponse.attributeTypeMap = [ name: "namedFormFields", baseName: "named_form_fields", type: "Array" - }, - { - name: "accounts", - baseName: "accounts", - type: "Array" } ]; @@ -22582,11 +22577,6 @@ TemplateResponseAccount.attributeTypeMap = [ baseName: "account_id", type: "string" }, - { - name: "emailAddress", - baseName: "email_address", - type: "string" - }, { name: "isLocked", baseName: "is_locked", @@ -22606,6 +22596,11 @@ TemplateResponseAccount.attributeTypeMap = [ name: "quotas", baseName: "quotas", type: "TemplateResponseAccountQuota" + }, + { + name: "emailAddress", + baseName: "email_address", + type: "string" } ]; @@ -22679,11 +22674,6 @@ TemplateResponseDocument.attributeTypeMap = [ baseName: "name", type: "string" }, - { - name: "index", - baseName: "index", - type: "number" - }, { name: "fieldGroups", baseName: "field_groups", @@ -22703,6 +22693,11 @@ TemplateResponseDocument.attributeTypeMap = [ name: "staticFields", baseName: "static_fields", type: "Array" + }, + { + name: "index", + baseName: "index", + type: "number" } ]; @@ -22727,11 +22722,6 @@ var _TemplateResponseDocumentCustomFieldBase = class { var TemplateResponseDocumentCustomFieldBase = _TemplateResponseDocumentCustomFieldBase; TemplateResponseDocumentCustomFieldBase.discriminator = "type"; TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string" - }, { name: "apiId", baseName: "api_id", @@ -22743,8 +22733,8 @@ TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ type: "string" }, { - name: "signer", - baseName: "signer", + name: "type", + baseName: "type", type: "string" }, { @@ -22772,6 +22762,11 @@ TemplateResponseDocumentCustomFieldBase.attributeTypeMap = [ baseName: "required", type: "boolean" }, + { + name: "signer", + baseName: "signer", + type: "string" + }, { name: "group", baseName: "group", @@ -22944,11 +22939,6 @@ var _TemplateResponseDocumentFormFieldBase = class { var TemplateResponseDocumentFormFieldBase = _TemplateResponseDocumentFormFieldBase; TemplateResponseDocumentFormFieldBase.discriminator = "type"; TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string" - }, { name: "apiId", baseName: "api_id", @@ -22959,6 +22949,11 @@ TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ baseName: "name", type: "string" }, + { + name: "type", + baseName: "type", + type: "string" + }, { name: "signer", baseName: "signer", @@ -22988,11 +22983,6 @@ TemplateResponseDocumentFormFieldBase.attributeTypeMap = [ name: "required", baseName: "required", type: "boolean" - }, - { - name: "group", - baseName: "group", - type: "string" } ]; @@ -23019,6 +23009,11 @@ TemplateResponseDocumentFormFieldCheckbox.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23045,6 +23040,11 @@ TemplateResponseDocumentFormFieldDateSigned.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23071,6 +23071,11 @@ TemplateResponseDocumentFormFieldDropdown.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23117,6 +23122,11 @@ TemplateResponseDocumentFormFieldHyperlink.attributeTypeMap = [ name: "fontFamily", baseName: "fontFamily", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23143,6 +23153,11 @@ TemplateResponseDocumentFormFieldInitials.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23169,6 +23184,11 @@ TemplateResponseDocumentFormFieldRadio.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23195,6 +23215,11 @@ TemplateResponseDocumentFormFieldSignature.attributeTypeMap = [ name: "type", baseName: "type", type: "string" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; @@ -23246,6 +23271,11 @@ TemplateResponseDocumentFormFieldText.attributeTypeMap = [ name: "validationType", baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum" + }, + { + name: "group", + baseName: "group", + type: "string" } ]; ((TemplateResponseDocumentFormFieldText2) => { @@ -23306,11 +23336,6 @@ var _TemplateResponseDocumentStaticFieldBase = class { var TemplateResponseDocumentStaticFieldBase = _TemplateResponseDocumentStaticFieldBase; TemplateResponseDocumentStaticFieldBase.discriminator = "type"; TemplateResponseDocumentStaticFieldBase.attributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string" - }, { name: "apiId", baseName: "api_id", @@ -23321,6 +23346,11 @@ TemplateResponseDocumentStaticFieldBase.attributeTypeMap = [ baseName: "name", type: "string" }, + { + name: "type", + baseName: "type", + type: "string" + }, { name: "signer", baseName: "signer", @@ -27310,14 +27340,6 @@ var OAuthApi = class { )) { return; } - if (handleErrorRangeResponse6( - reject, - error.response, - "4XX", - "ErrorResponse" - )) { - return; - } reject(error); } ); @@ -27413,14 +27435,6 @@ var OAuthApi = class { )) { return; } - if (handleErrorRangeResponse6( - reject, - error.response, - "4XX", - "ErrorResponse" - )) { - return; - } reject(error); } ); @@ -27454,16 +27468,6 @@ function handleErrorCodeResponse6(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse6(reject, response, code, returnType) { - let rangeCodeLeft = Number(code[0] + "00"); - let rangeCodeRight = Number(code[0] + "99"); - if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { - const body = ObjectSerializer.deserialize(response.data, returnType); - reject(new HttpError(response, body, response.status)); - return true; - } - return false; -} // api/reportApi.ts var defaultBasePath7 = "https://api.hellosign.com/v3"; @@ -27609,7 +27613,7 @@ var ReportApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse6( reject, error.response, "4XX", @@ -27651,7 +27655,7 @@ function handleErrorCodeResponse7(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse7(reject, response, code, returnType) { +function handleErrorRangeResponse6(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27806,7 +27810,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -27921,7 +27925,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28004,7 +28008,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28118,7 +28122,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28233,7 +28237,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28335,7 +28339,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28431,7 +28435,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28533,7 +28537,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28629,7 +28633,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28742,7 +28746,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28839,7 +28843,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -28962,7 +28966,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -29040,7 +29044,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -29154,7 +29158,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -29269,7 +29273,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -29392,7 +29396,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -29434,7 +29438,7 @@ function handleErrorCodeResponse8(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse8(reject, response, code, returnType) { +function handleErrorRangeResponse7(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -29599,7 +29603,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29709,7 +29713,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29783,7 +29787,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29870,7 +29874,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29964,7 +29968,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -30059,7 +30063,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -30168,7 +30172,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -30282,7 +30286,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -30390,7 +30394,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -30501,7 +30505,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -30542,7 +30546,7 @@ function handleErrorCodeResponse9(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse9(reject, response, code, returnType) { +function handleErrorRangeResponse8(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -30710,7 +30714,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30825,7 +30829,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30940,7 +30944,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31023,7 +31027,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31124,7 +31128,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31220,7 +31224,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31322,7 +31326,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31418,7 +31422,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31531,7 +31535,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31654,7 +31658,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31777,7 +31781,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -31819,7 +31823,7 @@ function handleErrorCodeResponse10(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse10(reject, response, code, returnType) { +function handleErrorRangeResponse9(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -31979,7 +31983,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -32094,7 +32098,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -32209,7 +32213,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -32332,7 +32336,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse11( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -32374,7 +32378,7 @@ function handleErrorCodeResponse11(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse11(reject, response, code, returnType) { +function handleErrorRangeResponse10(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { diff --git a/sdks/node/docs/model/OAuthTokenRefreshRequest.md b/sdks/node/docs/model/OAuthTokenRefreshRequest.md index 8a24bdc15..d5dc06d1b 100644 --- a/sdks/node/docs/model/OAuthTokenRefreshRequest.md +++ b/sdks/node/docs/model/OAuthTokenRefreshRequest.md @@ -8,7 +8,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grantType`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refreshToken`*_required_ | ```string``` | The token provided when you got the expired access token. | | -| `clientId` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | -| `clientSecret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md index 05c82cd71..0a13c1f8e 100644 --- a/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,9 +6,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | -| `editUrl` | ```string``` | Link to edit the template. | | -| `expiresAt` | ```number``` | When the link expires. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | +| `editUrl`*_required_ | ```string``` | Link to edit the template. | | +| `expiresAt`*_required_ | ```number``` | When the link expires. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/node/docs/model/TemplateCreateResponseTemplate.md index 3b4e62005..f96ba4cd2 100644 --- a/sdks/node/docs/model/TemplateCreateResponseTemplate.md +++ b/sdks/node/docs/model/TemplateCreateResponseTemplate.md @@ -6,6 +6,6 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponse.md b/sdks/node/docs/model/TemplateResponse.md index e82af4305..611a51c41 100644 --- a/sdks/node/docs/model/TemplateResponse.md +++ b/sdks/node/docs/model/TemplateResponse.md @@ -6,20 +6,21 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | -| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | +| `title`*_required_ | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `isCreator`*_required_ | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `canEdit`*_required_ | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `isLocked`*_required_ | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```number``` | Time the template was last updated. | | | `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `isCreator` | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `canEdit` | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `isLocked` | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | | `metadata` | ```object``` | The metadata attached to the template. | | | `signerRoles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | | `ccRoles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | [[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/TemplateResponseAccount.md b/sdks/node/docs/model/TemplateResponseAccount.md index 524109d96..eb890053e 100644 --- a/sdks/node/docs/model/TemplateResponseAccount.md +++ b/sdks/node/docs/model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `accountId` | ```string``` | The id of the Account. | | +| `accountId`*_required_ | ```string``` | The id of the Account. | | +| `isLocked`*_required_ | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `isPaidHs`*_required_ | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `isPaidHf`*_required_ | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | | `emailAddress` | ```string``` | The email address associated with the Account. | | -| `isLocked` | ```boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `isPaidHs` | ```boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `isPaidHf` | ```boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseAccountQuota.md b/sdks/node/docs/model/TemplateResponseAccountQuota.md index 587c6dab3..ff782d764 100644 --- a/sdks/node/docs/model/TemplateResponseAccountQuota.md +++ b/sdks/node/docs/model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templatesLeft` | ```number``` | API templates remaining. | | -| `apiSignatureRequestsLeft` | ```number``` | API signature requests remaining. | | -| `documentsLeft` | ```number``` | Signature requests remaining. | | -| `smsVerificationsLeft` | ```number``` | SMS verifications remaining. | | +| `templatesLeft`*_required_ | ```number``` | API templates remaining. | | +| `apiSignatureRequestsLeft`*_required_ | ```number``` | API signature requests remaining. | | +| `documentsLeft`*_required_ | ```number``` | Signature requests remaining. | | +| `smsVerificationsLeft`*_required_ | ```number``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/node/docs/model/TemplateResponseCCRole.md index 32ad82ef9..74c81b18d 100644 --- a/sdks/node/docs/model/TemplateResponseCCRole.md +++ b/sdks/node/docs/model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/node/docs/model/TemplateResponseDocument.md index 5f3f0d214..50fa698f4 100644 --- a/sdks/node/docs/model/TemplateResponseDocument.md +++ b/sdks/node/docs/model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | Name of the associated file. | | +| `name`*_required_ | ```string``` | Name of the associated file. | | +| `fieldGroups`*_required_ | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `formFields`*_required_ | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `customFields`*_required_ | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `staticFields`*_required_ | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```number``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `fieldGroups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `formFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `staticFields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md index 81418366f..4a9b70f2a 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `apiId`*_required_ | ```string``` | The unique ID for this field. | | +| `name`*_required_ | ```string``` | The name of the Custom Field. | | | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | The unique ID for this field. | | -| `name` | ```string``` | The name of the Custom Field. | | +| `x`*_required_ | ```number``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```number``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```number``` | The width in pixels of this form field. | | +| `height`*_required_ | ```number``` | The height in pixels of this form field. | | +| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```number``` | The horizontal offset in pixels for this form field. | | -| `y` | ```number``` | The vertical offset in pixels for this form field. | | -| `width` | ```number``` | The width in pixels of this form field. | | -| `height` | ```number``` | The height in pixels of this form field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md index 035c69583..84a007361 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentCustomFieldText.md @@ -7,9 +7,9 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md index 51f7c3369..b60f4eb75 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```string``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md index 95e4fa470..965bc8c08 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFieldGroupRule.md @@ -6,7 +6,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `groupLabel` | ```string``` | Name of the group | | +| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `groupLabel`*_required_ | ```string``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md index 859662984..bdae5de92 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldBase.md @@ -6,15 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `apiId`*_required_ | ```string``` | A unique id for the form field. | | +| `name`*_required_ | ```string``` | The name of the form field. | | | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | A unique id for the form field. | | -| `name` | ```string``` | The name of the form field. | | -| `signer` | ```string``` | The signer of the Form Field. | | -| `x` | ```number``` | The horizontal offset in pixels for this form field. | | -| `y` | ```number``` | The vertical offset in pixels for this form field. | | -| `width` | ```number``` | The width in pixels of this form field. | | -| `height` | ```number``` | The height in pixels of this form field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```string``` | The signer of the Form Field. | | +| `x`*_required_ | ```number``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```number``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```number``` | The width in pixels of this form field. | | +| `height`*_required_ | ```number``` | The height in pixels of this form field. | | +| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md index f2153cbc1..2ee1b9e5e 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldCheckbox.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md index ada92f315..8996ce7a3 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDateSigned.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md index c868840bd..35cadabb5 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldDropdown.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md index fadb22b4f..ec72f7901 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,9 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldInitials.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md index 9040699a9..ab0ccda06 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldInitials.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldRadio.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md index 409352e50..3b888caf7 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldRadio.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md index 3336b5b0d..b46f1d963 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldSignature.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md index c335bce0a..c2769f4fc 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/node/docs/model/TemplateResponseDocumentFormFieldText.md @@ -7,10 +7,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `isMultiline` | ```boolean``` | Whether this form field is multiline text. | | -| `originalFontSize` | ```number``` | Original font size used in this form field's text. | | -| `fontFamily` | ```string``` | Font family used in this form field's text. | | +| `avgTextLength`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `isMultiline`*_required_ | ```boolean``` | Whether this form field is multiline text. | | +| `originalFontSize`*_required_ | ```number``` | Original font size used in this form field's text. | | +| `fontFamily`*_required_ | ```string``` | Font family used in this form field's text. | | | `validationType` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentStaticFieldBase.md b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md index 243c1d108..a5fe1b0f6 100644 --- a/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/node/docs/model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `apiId`*_required_ | ```string``` | A unique id for the static field. | | +| `name`*_required_ | ```string``` | The name of the static field. | | | `type`*_required_ | ```string``` | | | -| `apiId` | ```string``` | A unique id for the static field. | | -| `name` | ```string``` | The name of the static field. | | -| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```number``` | The horizontal offset in pixels for this static field. | | -| `y` | ```number``` | The vertical offset in pixels for this static field. | | -| `width` | ```number``` | The width in pixels of this static field. | | -| `height` | ```number``` | The height in pixels of this static field. | | -| `required` | ```boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```string``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```number``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```number``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```number``` | The width in pixels of this static field. | | +| `height`*_required_ | ```number``` | The height in pixels of this static field. | | +| `required`*_required_ | ```boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md index 45daf9dae..585551694 100644 --- a/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/node/docs/model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `numLines` | ```number``` | Number of lines. | | -| `numCharsPerLine` | ```number``` | Number of characters per line. | | +| `numLines`*_required_ | ```number``` | Number of lines. | | +| `numCharsPerLine`*_required_ | ```number``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/node/docs/model/TemplateResponseSignerRole.md index e33fced3c..d3456d9cf 100644 --- a/sdks/node/docs/model/TemplateResponseSignerRole.md +++ b/sdks/node/docs/model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | | `order` | ```number``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md index aea14ab0c..90feb3f29 100644 --- a/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/node/docs/model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templateId` | ```string``` | The id of the Template. | | +| `templateId`*_required_ | ```string``` | The id of the Template. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | [[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/oAuthTokenRefreshRequest.ts b/sdks/node/model/oAuthTokenRefreshRequest.ts index 2f8971dd5..e6c6848b6 100644 --- a/sdks/node/model/oAuthTokenRefreshRequest.ts +++ b/sdks/node/model/oAuthTokenRefreshRequest.ts @@ -33,14 +33,6 @@ export class OAuthTokenRefreshRequest { * The token provided when you got the expired access token. */ "refreshToken": string; - /** - * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - */ - "clientId"?: string; - /** - * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - */ - "clientSecret"?: string; static discriminator: string | undefined = undefined; @@ -55,16 +47,6 @@ export class OAuthTokenRefreshRequest { baseName: "refresh_token", type: "string", }, - { - name: "clientId", - baseName: "client_id", - type: "string", - }, - { - name: "clientSecret", - baseName: "client_secret", - type: "string", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts index af7f9a71b..259954445 100644 --- a/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts +++ b/sdks/node/model/templateCreateEmbeddedDraftResponseTemplate.ts @@ -32,15 +32,15 @@ export class TemplateCreateEmbeddedDraftResponseTemplate { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; /** * Link to edit the template. */ - "editUrl"?: string; + "editUrl": string; /** * When the link expires. */ - "expiresAt"?: number; + "expiresAt": number; /** * A list of warnings. */ diff --git a/sdks/node/model/templateCreateResponseTemplate.ts b/sdks/node/model/templateCreateResponseTemplate.ts index cdcd61167..e6e8a7ea6 100644 --- a/sdks/node/model/templateCreateResponseTemplate.ts +++ b/sdks/node/model/templateCreateResponseTemplate.ts @@ -31,7 +31,7 @@ export class TemplateCreateResponseTemplate { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponse.ts b/sdks/node/model/templateResponse.ts index 88df4c09b..53158e8d7 100644 --- a/sdks/node/model/templateResponse.ts +++ b/sdks/node/model/templateResponse.ts @@ -23,6 +23,7 @@ */ import { AttributeTypeMap, ObjectSerializer } from "./"; +import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -37,35 +38,47 @@ export class TemplateResponse { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; /** * The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. */ - "title"?: string; + "title": string; /** * The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. */ - "message"?: string; + "message": string; /** - * Time the template was last updated. + * `true` if you are the owner of this template, `false` if it\'s been shared with you by a team member. */ - "updatedAt"?: number; + "isCreator": boolean; /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. + * Indicates whether edit rights have been granted to you by the owner (always `true` if that\'s you). */ - "isEmbedded"?: boolean | null; + "canEdit": boolean; /** - * `true` if you are the owner of this template, `false` if it\'s been shared with you by a team member. + * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. */ - "isCreator"?: boolean | null; + "isLocked": boolean; /** - * Indicates whether edit rights have been granted to you by the owner (always `true` if that\'s you). + * An array describing each document associated with this Template. Includes form field data for each document. */ - "canEdit"?: boolean | null; + "documents": Array; /** - * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + * An array of the Accounts that can use this Template. + */ + "accounts": Array; + /** + * Signer attachments. */ - "isLocked"?: boolean | null; + "attachments": Array; + /** + * Time the template was last updated. + */ + "updatedAt"?: number; + /** + * `true` if this template was created using an embedded flow, `false` if it was created on our website. + */ + "isEmbedded"?: boolean | null; /** * The metadata attached to the template. */ @@ -78,10 +91,6 @@ export class TemplateResponse { * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. */ "ccRoles"?: Array; - /** - * An array describing each document associated with this Template. Includes form field data for each document. - */ - "documents"?: Array; /** * Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. */ @@ -90,10 +99,6 @@ export class TemplateResponse { * Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. */ "namedFormFields"?: Array | null; - /** - * An array of the Accounts that can use this Template. - */ - "accounts"?: Array | null; static discriminator: string | undefined = undefined; @@ -113,16 +118,6 @@ export class TemplateResponse { baseName: "message", type: "string", }, - { - name: "updatedAt", - baseName: "updated_at", - type: "number", - }, - { - name: "isEmbedded", - baseName: "is_embedded", - type: "boolean", - }, { name: "isCreator", baseName: "is_creator", @@ -138,6 +133,31 @@ export class TemplateResponse { baseName: "is_locked", type: "boolean", }, + { + name: "documents", + baseName: "documents", + type: "Array", + }, + { + name: "accounts", + baseName: "accounts", + type: "Array", + }, + { + name: "attachments", + baseName: "attachments", + type: "Array", + }, + { + name: "updatedAt", + baseName: "updated_at", + type: "number", + }, + { + name: "isEmbedded", + baseName: "is_embedded", + type: "boolean", + }, { name: "metadata", baseName: "metadata", @@ -153,11 +173,6 @@ export class TemplateResponse { baseName: "cc_roles", type: "Array", }, - { - name: "documents", - baseName: "documents", - type: "Array", - }, { name: "customFields", baseName: "custom_fields", @@ -168,11 +183,6 @@ export class TemplateResponse { baseName: "named_form_fields", type: "Array", }, - { - name: "accounts", - baseName: "accounts", - type: "Array", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseAccount.ts b/sdks/node/model/templateResponseAccount.ts index 3b43d9351..86f230130 100644 --- a/sdks/node/model/templateResponseAccount.ts +++ b/sdks/node/model/templateResponseAccount.ts @@ -29,24 +29,24 @@ export class TemplateResponseAccount { /** * The id of the Account. */ - "accountId"?: string; - /** - * The email address associated with the Account. - */ - "emailAddress"?: string; + "accountId": string; /** * Returns `true` if the user has been locked out of their account by a team admin. */ - "isLocked"?: boolean; + "isLocked": boolean; /** * Returns `true` if the user has a paid Dropbox Sign account. */ - "isPaidHs"?: boolean; + "isPaidHs": boolean; /** * Returns `true` if the user has a paid HelloFax account. */ - "isPaidHf"?: boolean; - "quotas"?: TemplateResponseAccountQuota; + "isPaidHf": boolean; + "quotas": TemplateResponseAccountQuota; + /** + * The email address associated with the Account. + */ + "emailAddress"?: string; static discriminator: string | undefined = undefined; @@ -56,11 +56,6 @@ export class TemplateResponseAccount { baseName: "account_id", type: "string", }, - { - name: "emailAddress", - baseName: "email_address", - type: "string", - }, { name: "isLocked", baseName: "is_locked", @@ -81,6 +76,11 @@ export class TemplateResponseAccount { baseName: "quotas", type: "TemplateResponseAccountQuota", }, + { + name: "emailAddress", + baseName: "email_address", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseAccountQuota.ts b/sdks/node/model/templateResponseAccountQuota.ts index e2d6669b6..fbb4547ac 100644 --- a/sdks/node/model/templateResponseAccountQuota.ts +++ b/sdks/node/model/templateResponseAccountQuota.ts @@ -31,19 +31,19 @@ export class TemplateResponseAccountQuota { /** * API templates remaining. */ - "templatesLeft"?: number; + "templatesLeft": number; /** * API signature requests remaining. */ - "apiSignatureRequestsLeft"?: number; + "apiSignatureRequestsLeft": number; /** * Signature requests remaining. */ - "documentsLeft"?: number; + "documentsLeft": number; /** * SMS verifications remaining. */ - "smsVerificationsLeft"?: number; + "smsVerificationsLeft": number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseCCRole.ts b/sdks/node/model/templateResponseCCRole.ts index b3b7a2fd7..442fe1f89 100644 --- a/sdks/node/model/templateResponseCCRole.ts +++ b/sdks/node/model/templateResponseCCRole.ts @@ -28,7 +28,7 @@ export class TemplateResponseCCRole { /** * The name of the Role. */ - "name"?: string; + "name": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocument.ts b/sdks/node/model/templateResponseDocument.ts index 0c7a19e02..4b55dfe81 100644 --- a/sdks/node/model/templateResponseDocument.ts +++ b/sdks/node/model/templateResponseDocument.ts @@ -32,27 +32,27 @@ export class TemplateResponseDocument { /** * Name of the associated file. */ - "name"?: string; - /** - * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - */ - "index"?: number; + "name": string; /** * An array of Form Field Group objects. */ - "fieldGroups"?: Array; + "fieldGroups": Array; /** * An array of Form Field objects containing the name and type of each named field. */ - "formFields"?: Array; + "formFields": Array; /** * An array of Form Field objects containing the name and type of each named field. */ - "customFields"?: Array; + "customFields": Array; /** * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ - "staticFields"?: Array | null; + "staticFields": Array; + /** + * Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + */ + "index"?: number; static discriminator: string | undefined = undefined; @@ -62,11 +62,6 @@ export class TemplateResponseDocument { baseName: "name", type: "string", }, - { - name: "index", - baseName: "index", - type: "number", - }, { name: "fieldGroups", baseName: "field_groups", @@ -87,6 +82,11 @@ export class TemplateResponseDocument { baseName: "static_fields", type: "Array", }, + { + name: "index", + baseName: "index", + type: "number", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts index a0ed43965..340f9200d 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldBase.ts @@ -28,39 +28,39 @@ import { AttributeTypeMap } from "./"; * An array of Form Field objects containing the name and type of each named field. */ export abstract class TemplateResponseDocumentCustomFieldBase { - "type": string; /** * The unique ID for this field. */ - "apiId"?: string; + "apiId": string; /** * The name of the Custom Field. */ - "name"?: string; - /** - * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - */ - "signer"?: number | string | null; + "name": string; + "type": string; /** * The horizontal offset in pixels for this form field. */ - "x"?: number; + "x": number; /** * The vertical offset in pixels for this form field. */ - "y"?: number; + "y": number; /** * The width in pixels of this form field. */ - "width"?: number; + "width": number; /** * The height in pixels of this form field. */ - "height"?: number; + "height": number; /** * Boolean showing whether or not this field is required. */ - "required"?: boolean; + "required": boolean; + /** + * The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + */ + "signer"?: number | string | null; /** * The name of the group this field is in. If this field is not a group, this defaults to `null`. */ @@ -69,11 +69,6 @@ export abstract class TemplateResponseDocumentCustomFieldBase { static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string", - }, { name: "apiId", baseName: "api_id", @@ -85,8 +80,8 @@ export abstract class TemplateResponseDocumentCustomFieldBase { type: "string", }, { - name: "signer", - baseName: "signer", + name: "type", + baseName: "type", type: "string", }, { @@ -114,6 +109,11 @@ export abstract class TemplateResponseDocumentCustomFieldBase { baseName: "required", type: "boolean", }, + { + name: "signer", + baseName: "signer", + type: "string", + }, { name: "group", baseName: "group", diff --git a/sdks/node/model/templateResponseDocumentCustomFieldText.ts b/sdks/node/model/templateResponseDocumentCustomFieldText.ts index 3f59efc19..f07ba6b45 100644 --- a/sdks/node/model/templateResponseDocumentCustomFieldText.ts +++ b/sdks/node/model/templateResponseDocumentCustomFieldText.ts @@ -34,19 +34,19 @@ export class TemplateResponseDocumentCustomFieldText extends TemplateResponseDoc * The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` */ "type": string = "text"; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "avgTextLength": TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline"?: boolean; + "isMultiline": boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize"?: number; + "originalFontSize": number; /** * Font family used in this form field\'s text. */ - "fontFamily"?: string; + "fontFamily": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFieldGroup.ts b/sdks/node/model/templateResponseDocumentFieldGroup.ts index 4d2f9c695..820863174 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroup.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroup.ts @@ -29,8 +29,8 @@ export class TemplateResponseDocumentFieldGroup { /** * The name of the form field group. */ - "name"?: string; - "rule"?: TemplateResponseDocumentFieldGroupRule; + "name": string; + "rule": TemplateResponseDocumentFieldGroupRule; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts index f5ad93cf4..4e8f93b10 100644 --- a/sdks/node/model/templateResponseDocumentFieldGroupRule.ts +++ b/sdks/node/model/templateResponseDocumentFieldGroupRule.ts @@ -31,11 +31,11 @@ export class TemplateResponseDocumentFieldGroupRule { /** * Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. */ - "requirement"?: string; + "requirement": string; /** * Name of the group */ - "groupLabel"?: string; + "groupLabel": string; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseDocumentFormFieldBase.ts b/sdks/node/model/templateResponseDocumentFormFieldBase.ts index 94242a4a9..e7aa32f85 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldBase.ts @@ -28,52 +28,43 @@ import { AttributeTypeMap } from "./"; * An array of Form Field objects containing the name and type of each named field. */ export abstract class TemplateResponseDocumentFormFieldBase { - "type": string; /** * A unique id for the form field. */ - "apiId"?: string; + "apiId": string; /** * The name of the form field. */ - "name"?: string; + "name": string; + "type": string; /** * The signer of the Form Field. */ - "signer"?: number | string; + "signer": number | string; /** * The horizontal offset in pixels for this form field. */ - "x"?: number; + "x": number; /** * The vertical offset in pixels for this form field. */ - "y"?: number; + "y": number; /** * The width in pixels of this form field. */ - "width"?: number; + "width": number; /** * The height in pixels of this form field. */ - "height"?: number; + "height": number; /** * Boolean showing whether or not this field is required. */ - "required"?: boolean; - /** - * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - */ - "group"?: string | null; + "required": boolean; static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string", - }, { name: "apiId", baseName: "api_id", @@ -84,6 +75,11 @@ export abstract class TemplateResponseDocumentFormFieldBase { baseName: "name", type: "string", }, + { + name: "type", + baseName: "type", + type: "string", + }, { name: "signer", baseName: "signer", @@ -114,11 +110,6 @@ export abstract class TemplateResponseDocumentFormFieldBase { baseName: "required", type: "boolean", }, - { - name: "group", - baseName: "group", - type: "string", - }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts b/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts index 5e0b6d88b..e27a9fd0a 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldCheckbox.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "checkbox"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts b/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts index b510aa57f..08ce11026 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldDateSigned.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "date_signed"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldDateSigned extends TemplateRespons baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts b/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts index e2878febc..0aeb3e4e0 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldDropdown.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "dropdown"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts index 4a5998959..2c2113493 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldHyperlink.ts @@ -34,19 +34,23 @@ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "hyperlink"; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "avgTextLength": TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline"?: boolean; + "isMultiline": boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize"?: number; + "originalFontSize": number; /** * Font family used in this form field\'s text. */ - "fontFamily"?: string; + "fontFamily": string; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -76,6 +80,11 @@ export class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponse baseName: "fontFamily", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldInitials.ts b/sdks/node/model/templateResponseDocumentFormFieldInitials.ts index 1b14087a4..02f89a99e 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldInitials.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldInitials.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "initials"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldInitials extends TemplateResponseD baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldRadio.ts b/sdks/node/model/templateResponseDocumentFormFieldRadio.ts index 3a20f95a0..0841c0d5a 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldRadio.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldRadio.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "radio"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group": string; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocu baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldSignature.ts b/sdks/node/model/templateResponseDocumentFormFieldSignature.ts index c069e00aa..8467c9103 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldSignature.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldSignature.ts @@ -33,6 +33,10 @@ export class TemplateResponseDocumentFormFieldSignature extends TemplateResponse * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "signature"; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -42,6 +46,11 @@ export class TemplateResponseDocumentFormFieldSignature extends TemplateResponse baseName: "type", type: "string", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentFormFieldText.ts b/sdks/node/model/templateResponseDocumentFormFieldText.ts index 2c320d342..9f8ebcc91 100644 --- a/sdks/node/model/templateResponseDocumentFormFieldText.ts +++ b/sdks/node/model/templateResponseDocumentFormFieldText.ts @@ -34,23 +34,27 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum * The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` */ "type": string = "text"; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; + "avgTextLength": TemplateResponseFieldAvgTextLength; /** * Whether this form field is multiline text. */ - "isMultiline"?: boolean; + "isMultiline": boolean; /** * Original font size used in this form field\'s text. */ - "originalFontSize"?: number; + "originalFontSize": number; /** * Font family used in this form field\'s text. */ - "fontFamily"?: string; + "fontFamily": string; /** * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. */ "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; + /** + * The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + */ + "group"?: string | null; static discriminator: string | undefined = undefined; @@ -85,6 +89,11 @@ export class TemplateResponseDocumentFormFieldText extends TemplateResponseDocum baseName: "validation_type", type: "TemplateResponseDocumentFormFieldText.ValidationTypeEnum", }, + { + name: "group", + baseName: "group", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts index 04d3275ef..6640046d7 100644 --- a/sdks/node/model/templateResponseDocumentStaticFieldBase.ts +++ b/sdks/node/model/templateResponseDocumentStaticFieldBase.ts @@ -28,39 +28,39 @@ import { AttributeTypeMap } from "./"; * An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. */ export abstract class TemplateResponseDocumentStaticFieldBase { - "type": string; /** * A unique id for the static field. */ - "apiId"?: string; + "apiId": string; /** * The name of the static field. */ - "name"?: string; + "name": string; + "type": string; /** * The signer of the Static Field. */ - "signer"?: string = "me_now"; + "signer": string = "me_now"; /** * The horizontal offset in pixels for this static field. */ - "x"?: number; + "x": number; /** * The vertical offset in pixels for this static field. */ - "y"?: number; + "y": number; /** * The width in pixels of this static field. */ - "width"?: number; + "width": number; /** * The height in pixels of this static field. */ - "height"?: number; + "height": number; /** * Boolean showing whether or not this field is required. */ - "required"?: boolean; + "required": boolean; /** * The name of the group this field is in. If this field is not a group, this defaults to `null`. */ @@ -69,11 +69,6 @@ export abstract class TemplateResponseDocumentStaticFieldBase { static discriminator: string | undefined = "type"; static attributeTypeMap: AttributeTypeMap = [ - { - name: "type", - baseName: "type", - type: "string", - }, { name: "apiId", baseName: "api_id", @@ -84,6 +79,11 @@ export abstract class TemplateResponseDocumentStaticFieldBase { baseName: "name", type: "string", }, + { + name: "type", + baseName: "type", + type: "string", + }, { name: "signer", baseName: "signer", diff --git a/sdks/node/model/templateResponseFieldAvgTextLength.ts b/sdks/node/model/templateResponseFieldAvgTextLength.ts index d0a4fc396..c95ebfbdd 100644 --- a/sdks/node/model/templateResponseFieldAvgTextLength.ts +++ b/sdks/node/model/templateResponseFieldAvgTextLength.ts @@ -31,11 +31,11 @@ export class TemplateResponseFieldAvgTextLength { /** * Number of lines. */ - "numLines"?: number; + "numLines": number; /** * Number of characters per line. */ - "numCharsPerLine"?: number; + "numCharsPerLine": number; static discriminator: string | undefined = undefined; diff --git a/sdks/node/model/templateResponseSignerRole.ts b/sdks/node/model/templateResponseSignerRole.ts index 9bebd958f..a4950641a 100644 --- a/sdks/node/model/templateResponseSignerRole.ts +++ b/sdks/node/model/templateResponseSignerRole.ts @@ -28,7 +28,7 @@ export class TemplateResponseSignerRole { /** * The name of the Role. */ - "name"?: string; + "name": string; /** * If signer order is assigned this is the 0-based index for this role. */ diff --git a/sdks/node/model/templateUpdateFilesResponseTemplate.ts b/sdks/node/model/templateUpdateFilesResponseTemplate.ts index 98e18dabc..8d49e2d1b 100644 --- a/sdks/node/model/templateUpdateFilesResponseTemplate.ts +++ b/sdks/node/model/templateUpdateFilesResponseTemplate.ts @@ -32,7 +32,7 @@ export class TemplateUpdateFilesResponseTemplate { /** * The id of the Template. */ - "templateId"?: string; + "templateId": string; /** * A list of warnings. */ diff --git a/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts b/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts index 71f3d108f..53211884e 100644 --- a/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts +++ b/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts @@ -2,8 +2,6 @@ import { AttributeTypeMap } from "./"; export declare class OAuthTokenRefreshRequest { "grantType": string; "refreshToken": string; - "clientId"?: string; - "clientSecret"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts b/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts index 7287dbec2..124051aa9 100644 --- a/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts +++ b/sdks/node/types/model/templateCreateEmbeddedDraftResponseTemplate.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; import { WarningResponse } from "./warningResponse"; export declare class TemplateCreateEmbeddedDraftResponseTemplate { - "templateId"?: string; - "editUrl"?: string; - "expiresAt"?: number; + "templateId": string; + "editUrl": string; + "expiresAt": number; "warnings"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateCreateResponseTemplate.d.ts b/sdks/node/types/model/templateCreateResponseTemplate.d.ts index cc5c4e9a6..272ddeec1 100644 --- a/sdks/node/types/model/templateCreateResponseTemplate.d.ts +++ b/sdks/node/types/model/templateCreateResponseTemplate.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateCreateResponseTemplate { - "templateId"?: string; + "templateId": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponse.d.ts b/sdks/node/types/model/templateResponse.d.ts index 8ac333e50..655c23adc 100644 --- a/sdks/node/types/model/templateResponse.d.ts +++ b/sdks/node/types/model/templateResponse.d.ts @@ -1,4 +1,5 @@ import { AttributeTypeMap } from "./"; +import { SignatureRequestResponseAttachment } from "./signatureRequestResponseAttachment"; import { TemplateResponseAccount } from "./templateResponseAccount"; import { TemplateResponseCCRole } from "./templateResponseCCRole"; import { TemplateResponseDocument } from "./templateResponseDocument"; @@ -6,21 +7,22 @@ import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocum import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; import { TemplateResponseSignerRole } from "./templateResponseSignerRole"; export declare class TemplateResponse { - "templateId"?: string; - "title"?: string; - "message"?: string; + "templateId": string; + "title": string; + "message": string; + "isCreator": boolean; + "canEdit": boolean; + "isLocked": boolean; + "documents": Array; + "accounts": Array; + "attachments": Array; "updatedAt"?: number; "isEmbedded"?: boolean | null; - "isCreator"?: boolean | null; - "canEdit"?: boolean | null; - "isLocked"?: boolean | null; "metadata"?: object; "signerRoles"?: Array; "ccRoles"?: Array; - "documents"?: Array; "customFields"?: Array | null; "namedFormFields"?: Array | null; - "accounts"?: Array | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseAccount.d.ts b/sdks/node/types/model/templateResponseAccount.d.ts index 514cb2550..e8995a23f 100644 --- a/sdks/node/types/model/templateResponseAccount.d.ts +++ b/sdks/node/types/model/templateResponseAccount.d.ts @@ -1,12 +1,12 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseAccountQuota } from "./templateResponseAccountQuota"; export declare class TemplateResponseAccount { - "accountId"?: string; + "accountId": string; + "isLocked": boolean; + "isPaidHs": boolean; + "isPaidHf": boolean; + "quotas": TemplateResponseAccountQuota; "emailAddress"?: string; - "isLocked"?: boolean; - "isPaidHs"?: boolean; - "isPaidHf"?: boolean; - "quotas"?: TemplateResponseAccountQuota; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseAccountQuota.d.ts b/sdks/node/types/model/templateResponseAccountQuota.d.ts index e8ef0162f..c5ae8ac28 100644 --- a/sdks/node/types/model/templateResponseAccountQuota.d.ts +++ b/sdks/node/types/model/templateResponseAccountQuota.d.ts @@ -1,9 +1,9 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseAccountQuota { - "templatesLeft"?: number; - "apiSignatureRequestsLeft"?: number; - "documentsLeft"?: number; - "smsVerificationsLeft"?: number; + "templatesLeft": number; + "apiSignatureRequestsLeft": number; + "documentsLeft": number; + "smsVerificationsLeft": number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseCCRole.d.ts b/sdks/node/types/model/templateResponseCCRole.d.ts index ebb6cd371..a96c9497c 100644 --- a/sdks/node/types/model/templateResponseCCRole.d.ts +++ b/sdks/node/types/model/templateResponseCCRole.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseCCRole { - "name"?: string; + "name": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocument.d.ts b/sdks/node/types/model/templateResponseDocument.d.ts index 41b453769..211537e77 100644 --- a/sdks/node/types/model/templateResponseDocument.d.ts +++ b/sdks/node/types/model/templateResponseDocument.d.ts @@ -4,12 +4,12 @@ import { TemplateResponseDocumentFieldGroup } from "./templateResponseDocumentFi import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; import { TemplateResponseDocumentStaticFieldBase } from "./templateResponseDocumentStaticFieldBase"; export declare class TemplateResponseDocument { - "name"?: string; + "name": string; + "fieldGroups": Array; + "formFields": Array; + "customFields": Array; + "staticFields": Array; "index"?: number; - "fieldGroups"?: Array; - "formFields"?: Array; - "customFields"?: Array; - "staticFields"?: Array | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts index fa313114d..b3acf15af 100644 --- a/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentCustomFieldBase.d.ts @@ -1,14 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentCustomFieldBase { + "apiId": string; + "name": string; "type": string; - "apiId"?: string; - "name"?: string; + "x": number; + "y": number; + "width": number; + "height": number; + "required": boolean; "signer"?: number | string | null; - "x"?: number; - "y"?: number; - "width"?: number; - "height"?: number; - "required"?: boolean; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts b/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts index b2d499e48..f7d28ac9e 100644 --- a/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts +++ b/sdks/node/types/model/templateResponseDocumentCustomFieldText.d.ts @@ -3,10 +3,10 @@ import { TemplateResponseDocumentCustomFieldBase } from "./templateResponseDocum import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase { "type": string; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; - "isMultiline"?: boolean; - "originalFontSize"?: number; - "fontFamily"?: string; + "avgTextLength": TemplateResponseFieldAvgTextLength; + "isMultiline": boolean; + "originalFontSize": number; + "fontFamily": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts b/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts index d71655df9..da714dbd4 100644 --- a/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFieldGroup.d.ts @@ -1,8 +1,8 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFieldGroupRule } from "./templateResponseDocumentFieldGroupRule"; export declare class TemplateResponseDocumentFieldGroup { - "name"?: string; - "rule"?: TemplateResponseDocumentFieldGroupRule; + "name": string; + "rule": TemplateResponseDocumentFieldGroupRule; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts b/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts index 7f23a63d0..c3d444ca4 100644 --- a/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFieldGroupRule.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseDocumentFieldGroupRule { - "requirement"?: string; - "groupLabel"?: string; + "requirement": string; + "groupLabel": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts index 6df5fc173..935a559d8 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldBase.d.ts @@ -1,15 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentFormFieldBase { + "apiId": string; + "name": string; "type": string; - "apiId"?: string; - "name"?: string; - "signer"?: number | string; - "x"?: number; - "y"?: number; - "width"?: number; - "height"?: number; - "required"?: boolean; - "group"?: string | null; + "signer": number | string; + "x": number; + "y": number; + "width": number; + "height": number; + "required": boolean; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts index 0748b1e43..40adf3c30 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldCheckbox.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts index d66f2cb86..d755cb483 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldDateSigned.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts index deb3e5bc7..b9f96a26f 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldDropdown.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts index 4d10cf269..26c826911 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldHyperlink.d.ts @@ -3,10 +3,11 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase { "type": string; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; - "isMultiline"?: boolean; - "originalFontSize"?: number; - "fontFamily"?: string; + "avgTextLength": TemplateResponseFieldAvgTextLength; + "isMultiline": boolean; + "originalFontSize": number; + "fontFamily": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts index c935be083..6a1a035f5 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldInitials.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts index c3f174782..e0fc8a2bb 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldRadio.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase { "type": string; + "group": string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts index 06a96343d..d005bd0ee 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldSignature.d.ts @@ -2,6 +2,7 @@ import { AttributeTypeMap } from "./"; import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumentFormFieldBase"; export declare class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase { "type": string; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts b/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts index 9a65fc2ce..aa1ab468b 100644 --- a/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts +++ b/sdks/node/types/model/templateResponseDocumentFormFieldText.d.ts @@ -3,11 +3,12 @@ import { TemplateResponseDocumentFormFieldBase } from "./templateResponseDocumen import { TemplateResponseFieldAvgTextLength } from "./templateResponseFieldAvgTextLength"; export declare class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentFormFieldBase { "type": string; - "avgTextLength"?: TemplateResponseFieldAvgTextLength; - "isMultiline"?: boolean; - "originalFontSize"?: number; - "fontFamily"?: string; + "avgTextLength": TemplateResponseFieldAvgTextLength; + "isMultiline": boolean; + "originalFontSize": number; + "fontFamily": string; "validationType"?: TemplateResponseDocumentFormFieldText.ValidationTypeEnum; + "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts b/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts index 8120739cd..2c38e129d 100644 --- a/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts +++ b/sdks/node/types/model/templateResponseDocumentStaticFieldBase.d.ts @@ -1,14 +1,14 @@ import { AttributeTypeMap } from "./"; export declare abstract class TemplateResponseDocumentStaticFieldBase { + "apiId": string; + "name": string; "type": string; - "apiId"?: string; - "name"?: string; - "signer"?: string; - "x"?: number; - "y"?: number; - "width"?: number; - "height"?: number; - "required"?: boolean; + "signer": string; + "x": number; + "y": number; + "width": number; + "height": number; + "required": boolean; "group"?: string | null; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts b/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts index 811eebeb5..af926d77f 100644 --- a/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts +++ b/sdks/node/types/model/templateResponseFieldAvgTextLength.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseFieldAvgTextLength { - "numLines"?: number; - "numCharsPerLine"?: number; + "numLines": number; + "numCharsPerLine": number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/node/types/model/templateResponseSignerRole.d.ts b/sdks/node/types/model/templateResponseSignerRole.d.ts index ce2cf439d..27ca5435b 100644 --- a/sdks/node/types/model/templateResponseSignerRole.d.ts +++ b/sdks/node/types/model/templateResponseSignerRole.d.ts @@ -1,6 +1,6 @@ import { AttributeTypeMap } from "./"; export declare class TemplateResponseSignerRole { - "name"?: string; + "name": string; "order"?: number; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts b/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts index b7852797c..978f5030c 100644 --- a/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts +++ b/sdks/node/types/model/templateUpdateFilesResponseTemplate.d.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "./"; import { WarningResponse } from "./warningResponse"; export declare class TemplateUpdateFilesResponseTemplate { - "templateId"?: string; + "templateId": string; "warnings"?: Array; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; diff --git a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md index 9ba09db42..c9525386c 100644 --- a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md +++ b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md @@ -8,7 +8,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grant_type`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```string``` | The token provided when you got the expired access token. | | -| `client_id` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | -| `client_secret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md index 7604fd299..0f30e6698 100644 --- a/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,9 +6,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `edit_url` | ```string``` | Link to edit the template. | | -| `expires_at` | ```int``` | When the link expires. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `edit_url`*_required_ | ```string``` | Link to edit the template. | | +| `expires_at`*_required_ | ```int``` | When the link expires. | | | `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md index 0f25586c5..5942ecc07 100644 --- a/sdks/php/docs/Model/TemplateCreateResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateCreateResponseTemplate.md @@ -6,6 +6,6 @@ Template object with parameters: `template_id`. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index 2d6d768fd..ba33b6011 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -6,20 +6,21 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | -| `title` | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | +| `title`*_required_ | ```string``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```string``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `documents`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | | `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | | `metadata` | ```array``` | The metadata attached to the template. | | | `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | | `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | [[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/TemplateResponseAccount.md b/sdks/php/docs/Model/TemplateResponseAccount.md index fb9563bbc..4b7e24197 100644 --- a/sdks/php/docs/Model/TemplateResponseAccount.md +++ b/sdks/php/docs/Model/TemplateResponseAccount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```string``` | The id of the Account. | | +| `account_id`*_required_ | ```string``` | The id of the Account. | | +| `is_locked`*_required_ | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs`*_required_ | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf`*_required_ | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | | `email_address` | ```string``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```\Dropbox\Sign\Model\TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseAccountQuota.md b/sdks/php/docs/Model/TemplateResponseAccountQuota.md index 7b106a9ac..9002f1f57 100644 --- a/sdks/php/docs/Model/TemplateResponseAccountQuota.md +++ b/sdks/php/docs/Model/TemplateResponseAccountQuota.md @@ -6,9 +6,9 @@ An array of the designated CC roles that must be specified when sending a Signat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | API templates remaining. | | -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `templates_left`*_required_ | ```int``` | API templates remaining. | | +| `api_signature_requests_left`*_required_ | ```int``` | API signature requests remaining. | | +| `documents_left`*_required_ | ```int``` | Signature requests remaining. | | +| `sms_verifications_left`*_required_ | ```int``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/php/docs/Model/TemplateResponseCCRole.md index 32ad82ef9..74c81b18d 100644 --- a/sdks/php/docs/Model/TemplateResponseCCRole.md +++ b/sdks/php/docs/Model/TemplateResponseCCRole.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/php/docs/Model/TemplateResponseDocument.md index ab0518d3a..0d8420597 100644 --- a/sdks/php/docs/Model/TemplateResponseDocument.md +++ b/sdks/php/docs/Model/TemplateResponseDocument.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | Name of the associated file. | | +| `name`*_required_ | ```string``` | Name of the associated file. | | +| `field_groups`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md index 47b5bad52..2217892e4 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldBase.md @@ -6,15 +6,15 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```string``` | The unique ID for this field. | | +| `name`*_required_ | ```string``` | The name of the Custom Field. | | | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | The unique ID for this field. | | -| `name` | ```string``` | The name of the Custom Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `signer` | ```string``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md index 68e40af6b..147490139 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentCustomFieldText.md @@ -7,9 +7,9 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md index 233352654..4f74407c5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroup.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the form field group. | | -| `rule` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```string``` | The name of the form field group. | | +| `rule`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md index ad79e834e..b105c7ae2 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFieldGroupRule.md @@ -6,7 +6,7 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label` | ```string``` | Name of the group | | +| `requirement`*_required_ | ```string``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label`*_required_ | ```string``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md index 087f01080..867ed2bef 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldBase.md @@ -6,15 +6,14 @@ An array of Form Field objects containing the name and type of each named field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```string``` | A unique id for the form field. | | +| `name`*_required_ | ```string``` | The name of the form field. | | | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the form field. | | -| `name` | ```string``` | The name of the form field. | | -| `signer` | ```string``` | The signer of the Form Field. | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```string``` | The signer of the Form Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md index f2153cbc1..2ee1b9e5e 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldCheckbox.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md index ada92f315..8996ce7a3 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDateSigned.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md index c868840bd..35cadabb5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldDropdown.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md index d7e53fb84..c009374a8 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,9 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldInitials.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md index 9040699a9..ab0ccda06 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldInitials.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldRadio.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md index 409352e50..3b888caf7 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldRadio.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md index 3336b5b0d..b46f1d963 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldSignature.md @@ -7,5 +7,6 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md index 512bb9f15..1bef226d5 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentFormFieldText.md @@ -7,10 +7,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```string``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length` | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```string``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```string``` | Font family used in this form field's text. | | | `validation_type` | ```string``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentStaticFieldBase.md b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md index 3a7a044a4..3e681c640 100644 --- a/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/php/docs/Model/TemplateResponseDocumentStaticFieldBase.md @@ -6,15 +6,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```string``` | A unique id for the static field. | | +| `name`*_required_ | ```string``` | The name of the static field. | | | `type`*_required_ | ```string``` | | | -| `api_id` | ```string``` | A unique id for the static field. | | -| `name` | ```string``` | The name of the static field. | | -| `signer` | ```string``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```int``` | The horizontal offset in pixels for this static field. | | -| `y` | ```int``` | The vertical offset in pixels for this static field. | | -| `width` | ```int``` | The width in pixels of this static field. | | -| `height` | ```int``` | The height in pixels of this static field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```string``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```int``` | The width in pixels of this static field. | | +| `height`*_required_ | ```int``` | The height in pixels of this static field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```string``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md index b9db83c57..a1fbc0898 100644 --- a/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md +++ b/sdks/php/docs/Model/TemplateResponseFieldAvgTextLength.md @@ -6,7 +6,7 @@ Average text length in this field. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | Number of lines. | | -| `num_chars_per_line` | ```int``` | Number of characters per line. | | +| `num_lines`*_required_ | ```int``` | Number of lines. | | +| `num_chars_per_line`*_required_ | ```int``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/php/docs/Model/TemplateResponseSignerRole.md index fdf2f15d0..1881eb0b3 100644 --- a/sdks/php/docs/Model/TemplateResponseSignerRole.md +++ b/sdks/php/docs/Model/TemplateResponseSignerRole.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```string``` | The name of the Role. | | +| `name`*_required_ | ```string``` | The name of the Role. | | | `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md index b8fb3f5c2..ec5f1db4b 100644 --- a/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/php/docs/Model/TemplateUpdateFilesResponseTemplate.md @@ -6,7 +6,7 @@ Contains template id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```string``` | The id of the Template. | | +| `template_id`*_required_ | ```string``` | The id of the Template. | | | `warnings` | [```\Dropbox\Sign\Model\WarningResponse[]```](WarningResponse.md) | A list of warnings. | | [[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/Api/OAuthApi.php b/sdks/php/src/Api/OAuthApi.php index 81468626d..6fa77398a 100644 --- a/sdks/php/src/Api/OAuthApi.php +++ b/sdks/php/src/Api/OAuthApi.php @@ -211,15 +211,6 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ ); } - $result = $this->handleRangeCodeResponse( - $response, - '4XX', - '\Dropbox\Sign\Model\ErrorResponse' - ); - if ($result) { - return $result; - } - switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { @@ -278,9 +269,6 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ $response->getHeaders(), ]; } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { - throw $e; - } switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( @@ -594,15 +582,6 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ ); } - $result = $this->handleRangeCodeResponse( - $response, - '4XX', - '\Dropbox\Sign\Model\ErrorResponse' - ); - if ($result) { - return $result; - } - switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { @@ -661,9 +640,6 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ $response->getHeaders(), ]; } catch (ApiException $e) { - if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { - throw $e; - } switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( diff --git a/sdks/php/src/Model/OAuthTokenRefreshRequest.php b/sdks/php/src/Model/OAuthTokenRefreshRequest.php index 11cf05a3b..c4c7f93be 100644 --- a/sdks/php/src/Model/OAuthTokenRefreshRequest.php +++ b/sdks/php/src/Model/OAuthTokenRefreshRequest.php @@ -59,8 +59,6 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static $openAPITypes = [ 'grant_type' => 'string', 'refresh_token' => 'string', - 'client_id' => 'string', - 'client_secret' => 'string', ]; /** @@ -73,8 +71,6 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static $openAPIFormats = [ 'grant_type' => null, 'refresh_token' => null, - 'client_id' => null, - 'client_secret' => null, ]; /** @@ -85,8 +81,6 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static array $openAPINullables = [ 'grant_type' => false, 'refresh_token' => false, - 'client_id' => false, - 'client_secret' => false, ]; /** @@ -169,8 +163,6 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'grant_type' => 'grant_type', 'refresh_token' => 'refresh_token', - 'client_id' => 'client_id', - 'client_secret' => 'client_secret', ]; /** @@ -181,8 +173,6 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'grant_type' => 'setGrantType', 'refresh_token' => 'setRefreshToken', - 'client_id' => 'setClientId', - 'client_secret' => 'setClientSecret', ]; /** @@ -193,8 +183,6 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'grant_type' => 'getGrantType', 'refresh_token' => 'getRefreshToken', - 'client_id' => 'getClientId', - 'client_secret' => 'getClientSecret', ]; /** @@ -255,8 +243,6 @@ public function __construct(array $data = null) { $this->setIfExists('grant_type', $data ?? [], 'refresh_token'); $this->setIfExists('refresh_token', $data ?? [], null); - $this->setIfExists('client_id', $data ?? [], null); - $this->setIfExists('client_secret', $data ?? [], null); } /** @@ -378,60 +364,6 @@ public function setRefreshToken(string $refresh_token) return $this; } - /** - * Gets client_id - * - * @return string|null - */ - public function getClientId() - { - return $this->container['client_id']; - } - - /** - * Sets client_id - * - * @param string|null $client_id The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - * - * @return self - */ - public function setClientId(?string $client_id) - { - if (is_null($client_id)) { - throw new InvalidArgumentException('non-nullable client_id cannot be null'); - } - $this->container['client_id'] = $client_id; - - return $this; - } - - /** - * Gets client_secret - * - * @return string|null - */ - public function getClientSecret() - { - return $this->container['client_secret']; - } - - /** - * Sets client_secret - * - * @param string|null $client_secret The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - * - * @return self - */ - public function setClientSecret(?string $client_secret) - { - if (is_null($client_secret)) { - throw new InvalidArgumentException('non-nullable client_secret cannot be null'); - } - $this->container['client_secret'] = $client_secret; - - return $this; - } - /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php index 44031ce16..05073d3c9 100644 --- a/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateEmbeddedDraftResponseTemplate.php @@ -303,7 +303,18 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + if ($this->container['edit_url'] === null) { + $invalidProperties[] = "'edit_url' can't be null"; + } + if ($this->container['expires_at'] === null) { + $invalidProperties[] = "'expires_at' can't be null"; + } + return $invalidProperties; } /** @@ -320,7 +331,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -330,11 +341,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); @@ -347,7 +358,7 @@ public function setTemplateId(?string $template_id) /** * Gets edit_url * - * @return string|null + * @return string */ public function getEditUrl() { @@ -357,11 +368,11 @@ public function getEditUrl() /** * Sets edit_url * - * @param string|null $edit_url link to edit the template + * @param string $edit_url link to edit the template * * @return self */ - public function setEditUrl(?string $edit_url) + public function setEditUrl(string $edit_url) { if (is_null($edit_url)) { throw new InvalidArgumentException('non-nullable edit_url cannot be null'); @@ -374,7 +385,7 @@ public function setEditUrl(?string $edit_url) /** * Gets expires_at * - * @return int|null + * @return int */ public function getExpiresAt() { @@ -384,11 +395,11 @@ public function getExpiresAt() /** * Sets expires_at * - * @param int|null $expires_at when the link expires + * @param int $expires_at when the link expires * * @return self */ - public function setExpiresAt(?int $expires_at) + public function setExpiresAt(int $expires_at) { if (is_null($expires_at)) { throw new InvalidArgumentException('non-nullable expires_at cannot be null'); diff --git a/sdks/php/src/Model/TemplateCreateResponseTemplate.php b/sdks/php/src/Model/TemplateCreateResponseTemplate.php index 199aa3f74..d2bed5824 100644 --- a/sdks/php/src/Model/TemplateCreateResponseTemplate.php +++ b/sdks/php/src/Model/TemplateCreateResponseTemplate.php @@ -282,7 +282,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + return $invalidProperties; } /** @@ -299,7 +304,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -309,11 +314,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 4041f1856..b16bbe7d1 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -61,18 +61,19 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => 'string', 'title' => 'string', 'message' => 'string', - 'updated_at' => 'int', - 'is_embedded' => 'bool', 'is_creator' => 'bool', 'can_edit' => 'bool', 'is_locked' => 'bool', + 'documents' => '\Dropbox\Sign\Model\TemplateResponseDocument[]', + 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', + 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', + 'updated_at' => 'int', + 'is_embedded' => 'bool', 'metadata' => 'array', 'signer_roles' => '\Dropbox\Sign\Model\TemplateResponseSignerRole[]', 'cc_roles' => '\Dropbox\Sign\Model\TemplateResponseCCRole[]', - 'documents' => '\Dropbox\Sign\Model\TemplateResponseDocument[]', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', - 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', ]; /** @@ -86,18 +87,19 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => null, 'title' => null, 'message' => null, - 'updated_at' => null, - 'is_embedded' => null, 'is_creator' => null, 'can_edit' => null, 'is_locked' => null, + 'documents' => null, + 'accounts' => null, + 'attachments' => null, + 'updated_at' => null, + 'is_embedded' => null, 'metadata' => null, 'signer_roles' => null, 'cc_roles' => null, - 'documents' => null, 'custom_fields' => null, 'named_form_fields' => null, - 'accounts' => null, ]; /** @@ -109,18 +111,19 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'template_id' => false, 'title' => false, 'message' => false, + 'is_creator' => false, + 'can_edit' => false, + 'is_locked' => false, + 'documents' => false, + 'accounts' => false, + 'attachments' => false, 'updated_at' => false, 'is_embedded' => true, - 'is_creator' => true, - 'can_edit' => true, - 'is_locked' => true, 'metadata' => false, 'signer_roles' => false, 'cc_roles' => false, - 'documents' => false, 'custom_fields' => true, 'named_form_fields' => true, - 'accounts' => true, ]; /** @@ -204,18 +207,19 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'template_id', 'title' => 'title', 'message' => 'message', - 'updated_at' => 'updated_at', - 'is_embedded' => 'is_embedded', 'is_creator' => 'is_creator', 'can_edit' => 'can_edit', 'is_locked' => 'is_locked', + 'documents' => 'documents', + 'accounts' => 'accounts', + 'attachments' => 'attachments', + 'updated_at' => 'updated_at', + 'is_embedded' => 'is_embedded', 'metadata' => 'metadata', 'signer_roles' => 'signer_roles', 'cc_roles' => 'cc_roles', - 'documents' => 'documents', 'custom_fields' => 'custom_fields', 'named_form_fields' => 'named_form_fields', - 'accounts' => 'accounts', ]; /** @@ -227,18 +231,19 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'setTemplateId', 'title' => 'setTitle', 'message' => 'setMessage', - 'updated_at' => 'setUpdatedAt', - 'is_embedded' => 'setIsEmbedded', 'is_creator' => 'setIsCreator', 'can_edit' => 'setCanEdit', 'is_locked' => 'setIsLocked', + 'documents' => 'setDocuments', + 'accounts' => 'setAccounts', + 'attachments' => 'setAttachments', + 'updated_at' => 'setUpdatedAt', + 'is_embedded' => 'setIsEmbedded', 'metadata' => 'setMetadata', 'signer_roles' => 'setSignerRoles', 'cc_roles' => 'setCcRoles', - 'documents' => 'setDocuments', 'custom_fields' => 'setCustomFields', 'named_form_fields' => 'setNamedFormFields', - 'accounts' => 'setAccounts', ]; /** @@ -250,18 +255,19 @@ public function isNullableSetToNull(string $property): bool 'template_id' => 'getTemplateId', 'title' => 'getTitle', 'message' => 'getMessage', - 'updated_at' => 'getUpdatedAt', - 'is_embedded' => 'getIsEmbedded', 'is_creator' => 'getIsCreator', 'can_edit' => 'getCanEdit', 'is_locked' => 'getIsLocked', + 'documents' => 'getDocuments', + 'accounts' => 'getAccounts', + 'attachments' => 'getAttachments', + 'updated_at' => 'getUpdatedAt', + 'is_embedded' => 'getIsEmbedded', 'metadata' => 'getMetadata', 'signer_roles' => 'getSignerRoles', 'cc_roles' => 'getCcRoles', - 'documents' => 'getDocuments', 'custom_fields' => 'getCustomFields', 'named_form_fields' => 'getNamedFormFields', - 'accounts' => 'getAccounts', ]; /** @@ -323,18 +329,19 @@ public function __construct(array $data = null) $this->setIfExists('template_id', $data ?? [], null); $this->setIfExists('title', $data ?? [], null); $this->setIfExists('message', $data ?? [], null); - $this->setIfExists('updated_at', $data ?? [], null); - $this->setIfExists('is_embedded', $data ?? [], null); $this->setIfExists('is_creator', $data ?? [], null); $this->setIfExists('can_edit', $data ?? [], null); $this->setIfExists('is_locked', $data ?? [], null); + $this->setIfExists('documents', $data ?? [], null); + $this->setIfExists('accounts', $data ?? [], null); + $this->setIfExists('attachments', $data ?? [], null); + $this->setIfExists('updated_at', $data ?? [], null); + $this->setIfExists('is_embedded', $data ?? [], null); $this->setIfExists('metadata', $data ?? [], null); $this->setIfExists('signer_roles', $data ?? [], null); $this->setIfExists('cc_roles', $data ?? [], null); - $this->setIfExists('documents', $data ?? [], null); $this->setIfExists('custom_fields', $data ?? [], null); $this->setIfExists('named_form_fields', $data ?? [], null); - $this->setIfExists('accounts', $data ?? [], null); } /** @@ -380,7 +387,36 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + if ($this->container['title'] === null) { + $invalidProperties[] = "'title' can't be null"; + } + if ($this->container['message'] === null) { + $invalidProperties[] = "'message' can't be null"; + } + if ($this->container['is_creator'] === null) { + $invalidProperties[] = "'is_creator' can't be null"; + } + if ($this->container['can_edit'] === null) { + $invalidProperties[] = "'can_edit' can't be null"; + } + if ($this->container['is_locked'] === null) { + $invalidProperties[] = "'is_locked' can't be null"; + } + if ($this->container['documents'] === null) { + $invalidProperties[] = "'documents' can't be null"; + } + if ($this->container['accounts'] === null) { + $invalidProperties[] = "'accounts' can't be null"; + } + if ($this->container['attachments'] === null) { + $invalidProperties[] = "'attachments' can't be null"; + } + return $invalidProperties; } /** @@ -397,7 +433,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -407,11 +443,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); @@ -424,7 +460,7 @@ public function setTemplateId(?string $template_id) /** * Gets title * - * @return string|null + * @return string */ public function getTitle() { @@ -434,11 +470,11 @@ public function getTitle() /** * Sets title * - * @param string|null $title The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string $title The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * * @return self */ - public function setTitle(?string $title) + public function setTitle(string $title) { if (is_null($title)) { throw new InvalidArgumentException('non-nullable title cannot be null'); @@ -451,7 +487,7 @@ public function setTitle(?string $title) /** * Gets message * - * @return string|null + * @return string */ public function getMessage() { @@ -461,11 +497,11 @@ public function getMessage() /** * Sets message * - * @param string|null $message The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. + * @param string $message The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. * * @return self */ - public function setMessage(?string $message) + public function setMessage(string $message) { if (is_null($message)) { throw new InvalidArgumentException('non-nullable message cannot be null'); @@ -476,164 +512,224 @@ public function setMessage(?string $message) } /** - * Gets updated_at + * Gets is_creator * - * @return int|null + * @return bool */ - public function getUpdatedAt() + public function getIsCreator() { - return $this->container['updated_at']; + return $this->container['is_creator']; } /** - * Sets updated_at + * Sets is_creator * - * @param int|null $updated_at time the template was last updated + * @param bool $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member * * @return self */ - public function setUpdatedAt(?int $updated_at) + public function setIsCreator(bool $is_creator) { - if (is_null($updated_at)) { - throw new InvalidArgumentException('non-nullable updated_at cannot be null'); + if (is_null($is_creator)) { + throw new InvalidArgumentException('non-nullable is_creator cannot be null'); } - $this->container['updated_at'] = $updated_at; + $this->container['is_creator'] = $is_creator; return $this; } /** - * Gets is_embedded + * Gets can_edit * - * @return bool|null + * @return bool */ - public function getIsEmbedded() + public function getCanEdit() { - return $this->container['is_embedded']; + return $this->container['can_edit']; } /** - * Sets is_embedded + * Sets can_edit * - * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website + * @param bool $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) * * @return self */ - public function setIsEmbedded(?bool $is_embedded) + public function setCanEdit(bool $can_edit) { - if (is_null($is_embedded)) { - array_push($this->openAPINullablesSetToNull, 'is_embedded'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('is_embedded', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($can_edit)) { + throw new InvalidArgumentException('non-nullable can_edit cannot be null'); } - $this->container['is_embedded'] = $is_embedded; + $this->container['can_edit'] = $can_edit; return $this; } /** - * Gets is_creator + * Gets is_locked * - * @return bool|null + * @return bool */ - public function getIsCreator() + public function getIsLocked() { - return $this->container['is_creator']; + return $this->container['is_locked']; } /** - * Sets is_creator + * Sets is_locked * - * @param bool|null $is_creator `true` if you are the owner of this template, `false` if it's been shared with you by a team member + * @param bool $is_locked Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. * * @return self */ - public function setIsCreator(?bool $is_creator) + public function setIsLocked(bool $is_locked) { - if (is_null($is_creator)) { - array_push($this->openAPINullablesSetToNull, 'is_creator'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('is_creator', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($is_locked)) { + throw new InvalidArgumentException('non-nullable is_locked cannot be null'); } - $this->container['is_creator'] = $is_creator; + $this->container['is_locked'] = $is_locked; return $this; } /** - * Gets can_edit + * Gets documents * - * @return bool|null + * @return TemplateResponseDocument[] */ - public function getCanEdit() + public function getDocuments() { - return $this->container['can_edit']; + return $this->container['documents']; } /** - * Sets can_edit + * Sets documents * - * @param bool|null $can_edit indicates whether edit rights have been granted to you by the owner (always `true` if that's you) + * @param TemplateResponseDocument[] $documents An array describing each document associated with this Template. Includes form field data for each document. * * @return self */ - public function setCanEdit(?bool $can_edit) + public function setDocuments(array $documents) { - if (is_null($can_edit)) { - array_push($this->openAPINullablesSetToNull, 'can_edit'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('can_edit', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($documents)) { + throw new InvalidArgumentException('non-nullable documents cannot be null'); } - $this->container['can_edit'] = $can_edit; + $this->container['documents'] = $documents; return $this; } /** - * Gets is_locked + * Gets accounts + * + * @return TemplateResponseAccount[] + */ + public function getAccounts() + { + return $this->container['accounts']; + } + + /** + * Sets accounts + * + * @param TemplateResponseAccount[] $accounts an array of the Accounts that can use this Template + * + * @return self + */ + public function setAccounts(array $accounts) + { + if (is_null($accounts)) { + throw new InvalidArgumentException('non-nullable accounts cannot be null'); + } + $this->container['accounts'] = $accounts; + + return $this; + } + + /** + * Gets attachments + * + * @return SignatureRequestResponseAttachment[] + */ + public function getAttachments() + { + return $this->container['attachments']; + } + + /** + * Sets attachments + * + * @param SignatureRequestResponseAttachment[] $attachments signer attachments + * + * @return self + */ + public function setAttachments(array $attachments) + { + if (is_null($attachments)) { + throw new InvalidArgumentException('non-nullable attachments cannot be null'); + } + $this->container['attachments'] = $attachments; + + return $this; + } + + /** + * Gets updated_at + * + * @return int|null + */ + public function getUpdatedAt() + { + return $this->container['updated_at']; + } + + /** + * Sets updated_at + * + * @param int|null $updated_at time the template was last updated + * + * @return self + */ + public function setUpdatedAt(?int $updated_at) + { + if (is_null($updated_at)) { + throw new InvalidArgumentException('non-nullable updated_at cannot be null'); + } + $this->container['updated_at'] = $updated_at; + + return $this; + } + + /** + * Gets is_embedded * * @return bool|null */ - public function getIsLocked() + public function getIsEmbedded() { - return $this->container['is_locked']; + return $this->container['is_embedded']; } /** - * Sets is_locked + * Sets is_embedded * - * @param bool|null $is_locked Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. + * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website * * @return self */ - public function setIsLocked(?bool $is_locked) + public function setIsEmbedded(?bool $is_embedded) { - if (is_null($is_locked)) { - array_push($this->openAPINullablesSetToNull, 'is_locked'); + if (is_null($is_embedded)) { + array_push($this->openAPINullablesSetToNull, 'is_embedded'); } else { $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('is_locked', $nullablesSetToNull); + $index = array_search('is_embedded', $nullablesSetToNull); if ($index !== false) { unset($nullablesSetToNull[$index]); $this->setOpenAPINullablesSetToNull($nullablesSetToNull); } } - $this->container['is_locked'] = $is_locked; + $this->container['is_embedded'] = $is_embedded; return $this; } @@ -719,33 +815,6 @@ public function setCcRoles(?array $cc_roles) return $this; } - /** - * Gets documents - * - * @return TemplateResponseDocument[]|null - */ - public function getDocuments() - { - return $this->container['documents']; - } - - /** - * Sets documents - * - * @param TemplateResponseDocument[]|null $documents An array describing each document associated with this Template. Includes form field data for each document. - * - * @return self - */ - public function setDocuments(?array $documents) - { - if (is_null($documents)) { - throw new InvalidArgumentException('non-nullable documents cannot be null'); - } - $this->container['documents'] = $documents; - - return $this; - } - /** * Gets custom_fields * @@ -818,40 +887,6 @@ public function setNamedFormFields(?array $named_form_fields) return $this; } - /** - * Gets accounts - * - * @return TemplateResponseAccount[]|null - */ - public function getAccounts() - { - return $this->container['accounts']; - } - - /** - * Sets accounts - * - * @param TemplateResponseAccount[]|null $accounts an array of the Accounts that can use this Template - * - * @return self - */ - public function setAccounts(?array $accounts) - { - if (is_null($accounts)) { - array_push($this->openAPINullablesSetToNull, 'accounts'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('accounts', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } - } - $this->container['accounts'] = $accounts; - - return $this; - } - /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseAccount.php b/sdks/php/src/Model/TemplateResponseAccount.php index 47ddefabe..538aed394 100644 --- a/sdks/php/src/Model/TemplateResponseAccount.php +++ b/sdks/php/src/Model/TemplateResponseAccount.php @@ -58,11 +58,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ protected static $openAPITypes = [ 'account_id' => 'string', - 'email_address' => 'string', 'is_locked' => 'bool', 'is_paid_hs' => 'bool', 'is_paid_hf' => 'bool', 'quotas' => '\Dropbox\Sign\Model\TemplateResponseAccountQuota', + 'email_address' => 'string', ]; /** @@ -74,11 +74,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ protected static $openAPIFormats = [ 'account_id' => null, - 'email_address' => null, 'is_locked' => null, 'is_paid_hs' => null, 'is_paid_hf' => null, 'quotas' => null, + 'email_address' => null, ]; /** @@ -88,11 +88,11 @@ class TemplateResponseAccount implements ModelInterface, ArrayAccess, JsonSerial */ protected static array $openAPINullables = [ 'account_id' => false, - 'email_address' => false, 'is_locked' => false, 'is_paid_hs' => false, 'is_paid_hf' => false, 'quotas' => false, + 'email_address' => false, ]; /** @@ -174,11 +174,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'account_id' => 'account_id', - 'email_address' => 'email_address', 'is_locked' => 'is_locked', 'is_paid_hs' => 'is_paid_hs', 'is_paid_hf' => 'is_paid_hf', 'quotas' => 'quotas', + 'email_address' => 'email_address', ]; /** @@ -188,11 +188,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'account_id' => 'setAccountId', - 'email_address' => 'setEmailAddress', 'is_locked' => 'setIsLocked', 'is_paid_hs' => 'setIsPaidHs', 'is_paid_hf' => 'setIsPaidHf', 'quotas' => 'setQuotas', + 'email_address' => 'setEmailAddress', ]; /** @@ -202,11 +202,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'account_id' => 'getAccountId', - 'email_address' => 'getEmailAddress', 'is_locked' => 'getIsLocked', 'is_paid_hs' => 'getIsPaidHs', 'is_paid_hf' => 'getIsPaidHf', 'quotas' => 'getQuotas', + 'email_address' => 'getEmailAddress', ]; /** @@ -266,11 +266,11 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('account_id', $data ?? [], null); - $this->setIfExists('email_address', $data ?? [], null); $this->setIfExists('is_locked', $data ?? [], null); $this->setIfExists('is_paid_hs', $data ?? [], null); $this->setIfExists('is_paid_hf', $data ?? [], null); $this->setIfExists('quotas', $data ?? [], null); + $this->setIfExists('email_address', $data ?? [], null); } /** @@ -316,7 +316,24 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['account_id'] === null) { + $invalidProperties[] = "'account_id' can't be null"; + } + if ($this->container['is_locked'] === null) { + $invalidProperties[] = "'is_locked' can't be null"; + } + if ($this->container['is_paid_hs'] === null) { + $invalidProperties[] = "'is_paid_hs' can't be null"; + } + if ($this->container['is_paid_hf'] === null) { + $invalidProperties[] = "'is_paid_hf' can't be null"; + } + if ($this->container['quotas'] === null) { + $invalidProperties[] = "'quotas' can't be null"; + } + return $invalidProperties; } /** @@ -333,7 +350,7 @@ public function valid() /** * Gets account_id * - * @return string|null + * @return string */ public function getAccountId() { @@ -343,11 +360,11 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id the id of the Account + * @param string $account_id the id of the Account * * @return self */ - public function setAccountId(?string $account_id) + public function setAccountId(string $account_id) { if (is_null($account_id)) { throw new InvalidArgumentException('non-nullable account_id cannot be null'); @@ -357,37 +374,10 @@ public function setAccountId(?string $account_id) return $this; } - /** - * Gets email_address - * - * @return string|null - */ - public function getEmailAddress() - { - return $this->container['email_address']; - } - - /** - * Sets email_address - * - * @param string|null $email_address the email address associated with the Account - * - * @return self - */ - public function setEmailAddress(?string $email_address) - { - if (is_null($email_address)) { - throw new InvalidArgumentException('non-nullable email_address cannot be null'); - } - $this->container['email_address'] = $email_address; - - return $this; - } - /** * Gets is_locked * - * @return bool|null + * @return bool */ public function getIsLocked() { @@ -397,11 +387,11 @@ public function getIsLocked() /** * Sets is_locked * - * @param bool|null $is_locked returns `true` if the user has been locked out of their account by a team admin + * @param bool $is_locked returns `true` if the user has been locked out of their account by a team admin * * @return self */ - public function setIsLocked(?bool $is_locked) + public function setIsLocked(bool $is_locked) { if (is_null($is_locked)) { throw new InvalidArgumentException('non-nullable is_locked cannot be null'); @@ -414,7 +404,7 @@ public function setIsLocked(?bool $is_locked) /** * Gets is_paid_hs * - * @return bool|null + * @return bool */ public function getIsPaidHs() { @@ -424,11 +414,11 @@ public function getIsPaidHs() /** * Sets is_paid_hs * - * @param bool|null $is_paid_hs returns `true` if the user has a paid Dropbox Sign account + * @param bool $is_paid_hs returns `true` if the user has a paid Dropbox Sign account * * @return self */ - public function setIsPaidHs(?bool $is_paid_hs) + public function setIsPaidHs(bool $is_paid_hs) { if (is_null($is_paid_hs)) { throw new InvalidArgumentException('non-nullable is_paid_hs cannot be null'); @@ -441,7 +431,7 @@ public function setIsPaidHs(?bool $is_paid_hs) /** * Gets is_paid_hf * - * @return bool|null + * @return bool */ public function getIsPaidHf() { @@ -451,11 +441,11 @@ public function getIsPaidHf() /** * Sets is_paid_hf * - * @param bool|null $is_paid_hf returns `true` if the user has a paid HelloFax account + * @param bool $is_paid_hf returns `true` if the user has a paid HelloFax account * * @return self */ - public function setIsPaidHf(?bool $is_paid_hf) + public function setIsPaidHf(bool $is_paid_hf) { if (is_null($is_paid_hf)) { throw new InvalidArgumentException('non-nullable is_paid_hf cannot be null'); @@ -468,7 +458,7 @@ public function setIsPaidHf(?bool $is_paid_hf) /** * Gets quotas * - * @return TemplateResponseAccountQuota|null + * @return TemplateResponseAccountQuota */ public function getQuotas() { @@ -478,11 +468,11 @@ public function getQuotas() /** * Sets quotas * - * @param TemplateResponseAccountQuota|null $quotas quotas + * @param TemplateResponseAccountQuota $quotas quotas * * @return self */ - public function setQuotas(?TemplateResponseAccountQuota $quotas) + public function setQuotas(TemplateResponseAccountQuota $quotas) { if (is_null($quotas)) { throw new InvalidArgumentException('non-nullable quotas cannot be null'); @@ -492,6 +482,33 @@ public function setQuotas(?TemplateResponseAccountQuota $quotas) return $this; } + /** + * Gets email_address + * + * @return string|null + */ + public function getEmailAddress() + { + return $this->container['email_address']; + } + + /** + * Sets email_address + * + * @param string|null $email_address the email address associated with the Account + * + * @return self + */ + public function setEmailAddress(?string $email_address) + { + if (is_null($email_address)) { + throw new InvalidArgumentException('non-nullable email_address cannot be null'); + } + $this->container['email_address'] = $email_address; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseAccountQuota.php b/sdks/php/src/Model/TemplateResponseAccountQuota.php index 46386d6ec..e27a97325 100644 --- a/sdks/php/src/Model/TemplateResponseAccountQuota.php +++ b/sdks/php/src/Model/TemplateResponseAccountQuota.php @@ -303,7 +303,21 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['templates_left'] === null) { + $invalidProperties[] = "'templates_left' can't be null"; + } + if ($this->container['api_signature_requests_left'] === null) { + $invalidProperties[] = "'api_signature_requests_left' can't be null"; + } + if ($this->container['documents_left'] === null) { + $invalidProperties[] = "'documents_left' can't be null"; + } + if ($this->container['sms_verifications_left'] === null) { + $invalidProperties[] = "'sms_verifications_left' can't be null"; + } + return $invalidProperties; } /** @@ -320,7 +334,7 @@ public function valid() /** * Gets templates_left * - * @return int|null + * @return int */ public function getTemplatesLeft() { @@ -330,11 +344,11 @@ public function getTemplatesLeft() /** * Sets templates_left * - * @param int|null $templates_left API templates remaining + * @param int $templates_left API templates remaining * * @return self */ - public function setTemplatesLeft(?int $templates_left) + public function setTemplatesLeft(int $templates_left) { if (is_null($templates_left)) { throw new InvalidArgumentException('non-nullable templates_left cannot be null'); @@ -347,7 +361,7 @@ public function setTemplatesLeft(?int $templates_left) /** * Gets api_signature_requests_left * - * @return int|null + * @return int */ public function getApiSignatureRequestsLeft() { @@ -357,11 +371,11 @@ public function getApiSignatureRequestsLeft() /** * Sets api_signature_requests_left * - * @param int|null $api_signature_requests_left API signature requests remaining + * @param int $api_signature_requests_left API signature requests remaining * * @return self */ - public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) + public function setApiSignatureRequestsLeft(int $api_signature_requests_left) { if (is_null($api_signature_requests_left)) { throw new InvalidArgumentException('non-nullable api_signature_requests_left cannot be null'); @@ -374,7 +388,7 @@ public function setApiSignatureRequestsLeft(?int $api_signature_requests_left) /** * Gets documents_left * - * @return int|null + * @return int */ public function getDocumentsLeft() { @@ -384,11 +398,11 @@ public function getDocumentsLeft() /** * Sets documents_left * - * @param int|null $documents_left signature requests remaining + * @param int $documents_left signature requests remaining * * @return self */ - public function setDocumentsLeft(?int $documents_left) + public function setDocumentsLeft(int $documents_left) { if (is_null($documents_left)) { throw new InvalidArgumentException('non-nullable documents_left cannot be null'); @@ -401,7 +415,7 @@ public function setDocumentsLeft(?int $documents_left) /** * Gets sms_verifications_left * - * @return int|null + * @return int */ public function getSmsVerificationsLeft() { @@ -411,11 +425,11 @@ public function getSmsVerificationsLeft() /** * Sets sms_verifications_left * - * @param int|null $sms_verifications_left SMS verifications remaining + * @param int $sms_verifications_left SMS verifications remaining * * @return self */ - public function setSmsVerificationsLeft(?int $sms_verifications_left) + public function setSmsVerificationsLeft(int $sms_verifications_left) { if (is_null($sms_verifications_left)) { throw new InvalidArgumentException('non-nullable sms_verifications_left cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseCCRole.php b/sdks/php/src/Model/TemplateResponseCCRole.php index 06ee33219..28044c0ea 100644 --- a/sdks/php/src/Model/TemplateResponseCCRole.php +++ b/sdks/php/src/Model/TemplateResponseCCRole.php @@ -281,7 +281,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + return $invalidProperties; } /** @@ -298,7 +303,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -308,11 +313,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string $name the name of the Role * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocument.php b/sdks/php/src/Model/TemplateResponseDocument.php index 5377d4ba9..6bf7ba8e8 100644 --- a/sdks/php/src/Model/TemplateResponseDocument.php +++ b/sdks/php/src/Model/TemplateResponseDocument.php @@ -58,11 +58,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static $openAPITypes = [ 'name' => 'string', - 'index' => 'int', 'field_groups' => '\Dropbox\Sign\Model\TemplateResponseDocumentFieldGroup[]', 'form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'static_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentStaticFieldBase[]', + 'index' => 'int', ]; /** @@ -74,11 +74,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static $openAPIFormats = [ 'name' => null, - 'index' => null, 'field_groups' => null, 'form_fields' => null, 'custom_fields' => null, 'static_fields' => null, + 'index' => null, ]; /** @@ -88,11 +88,11 @@ class TemplateResponseDocument implements ModelInterface, ArrayAccess, JsonSeria */ protected static array $openAPINullables = [ 'name' => false, - 'index' => false, 'field_groups' => false, 'form_fields' => false, 'custom_fields' => false, - 'static_fields' => true, + 'static_fields' => false, + 'index' => false, ]; /** @@ -174,11 +174,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'name' => 'name', - 'index' => 'index', 'field_groups' => 'field_groups', 'form_fields' => 'form_fields', 'custom_fields' => 'custom_fields', 'static_fields' => 'static_fields', + 'index' => 'index', ]; /** @@ -188,11 +188,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'name' => 'setName', - 'index' => 'setIndex', 'field_groups' => 'setFieldGroups', 'form_fields' => 'setFormFields', 'custom_fields' => 'setCustomFields', 'static_fields' => 'setStaticFields', + 'index' => 'setIndex', ]; /** @@ -202,11 +202,11 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'name' => 'getName', - 'index' => 'getIndex', 'field_groups' => 'getFieldGroups', 'form_fields' => 'getFormFields', 'custom_fields' => 'getCustomFields', 'static_fields' => 'getStaticFields', + 'index' => 'getIndex', ]; /** @@ -266,11 +266,11 @@ public function getModelName() public function __construct(array $data = null) { $this->setIfExists('name', $data ?? [], null); - $this->setIfExists('index', $data ?? [], null); $this->setIfExists('field_groups', $data ?? [], null); $this->setIfExists('form_fields', $data ?? [], null); $this->setIfExists('custom_fields', $data ?? [], null); $this->setIfExists('static_fields', $data ?? [], null); + $this->setIfExists('index', $data ?? [], null); } /** @@ -316,7 +316,24 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + if ($this->container['field_groups'] === null) { + $invalidProperties[] = "'field_groups' can't be null"; + } + if ($this->container['form_fields'] === null) { + $invalidProperties[] = "'form_fields' can't be null"; + } + if ($this->container['custom_fields'] === null) { + $invalidProperties[] = "'custom_fields' can't be null"; + } + if ($this->container['static_fields'] === null) { + $invalidProperties[] = "'static_fields' can't be null"; + } + return $invalidProperties; } /** @@ -333,7 +350,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -343,11 +360,11 @@ public function getName() /** * Sets name * - * @param string|null $name name of the associated file + * @param string $name name of the associated file * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -357,37 +374,10 @@ public function setName(?string $name) return $this; } - /** - * Gets index - * - * @return int|null - */ - public function getIndex() - { - return $this->container['index']; - } - - /** - * Sets index - * - * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) - * - * @return self - */ - public function setIndex(?int $index) - { - if (is_null($index)) { - throw new InvalidArgumentException('non-nullable index cannot be null'); - } - $this->container['index'] = $index; - - return $this; - } - /** * Gets field_groups * - * @return TemplateResponseDocumentFieldGroup[]|null + * @return TemplateResponseDocumentFieldGroup[] */ public function getFieldGroups() { @@ -397,11 +387,11 @@ public function getFieldGroups() /** * Sets field_groups * - * @param TemplateResponseDocumentFieldGroup[]|null $field_groups an array of Form Field Group objects + * @param TemplateResponseDocumentFieldGroup[] $field_groups an array of Form Field Group objects * * @return self */ - public function setFieldGroups(?array $field_groups) + public function setFieldGroups(array $field_groups) { if (is_null($field_groups)) { throw new InvalidArgumentException('non-nullable field_groups cannot be null'); @@ -414,7 +404,7 @@ public function setFieldGroups(?array $field_groups) /** * Gets form_fields * - * @return TemplateResponseDocumentFormFieldBase[]|null + * @return TemplateResponseDocumentFormFieldBase[] */ public function getFormFields() { @@ -424,11 +414,11 @@ public function getFormFields() /** * Sets form_fields * - * @param TemplateResponseDocumentFormFieldBase[]|null $form_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentFormFieldBase[] $form_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setFormFields(?array $form_fields) + public function setFormFields(array $form_fields) { if (is_null($form_fields)) { throw new InvalidArgumentException('non-nullable form_fields cannot be null'); @@ -441,7 +431,7 @@ public function setFormFields(?array $form_fields) /** * Gets custom_fields * - * @return TemplateResponseDocumentCustomFieldBase[]|null + * @return TemplateResponseDocumentCustomFieldBase[] */ public function getCustomFields() { @@ -451,11 +441,11 @@ public function getCustomFields() /** * Sets custom_fields * - * @param TemplateResponseDocumentCustomFieldBase[]|null $custom_fields an array of Form Field objects containing the name and type of each named field + * @param TemplateResponseDocumentCustomFieldBase[] $custom_fields an array of Form Field objects containing the name and type of each named field * * @return self */ - public function setCustomFields(?array $custom_fields) + public function setCustomFields(array $custom_fields) { if (is_null($custom_fields)) { throw new InvalidArgumentException('non-nullable custom_fields cannot be null'); @@ -468,7 +458,7 @@ public function setCustomFields(?array $custom_fields) /** * Gets static_fields * - * @return TemplateResponseDocumentStaticFieldBase[]|null + * @return TemplateResponseDocumentStaticFieldBase[] */ public function getStaticFields() { @@ -478,27 +468,47 @@ public function getStaticFields() /** * Sets static_fields * - * @param TemplateResponseDocumentStaticFieldBase[]|null $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. + * @param TemplateResponseDocumentStaticFieldBase[] $static_fields An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. * * @return self */ - public function setStaticFields(?array $static_fields) + public function setStaticFields(array $static_fields) { if (is_null($static_fields)) { - array_push($this->openAPINullablesSetToNull, 'static_fields'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('static_fields', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + throw new InvalidArgumentException('non-nullable static_fields cannot be null'); } $this->container['static_fields'] = $static_fields; return $this; } + /** + * Gets index + * + * @return int|null + */ + public function getIndex() + { + return $this->container['index']; + } + + /** + * Sets index + * + * @param int|null $index document ordering, the lowest index is displayed first and the highest last (0-based indexing) + * + * @return self + */ + public function setIndex(?int $index) + { + if (is_null($index)) { + throw new InvalidArgumentException('non-nullable index cannot be null'); + } + $this->container['index'] = $index; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php index 011502522..0d5f29451 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldBase.php @@ -58,15 +58,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @var string[] */ protected static $openAPITypes = [ - 'type' => 'string', 'api_id' => 'string', 'name' => 'string', - 'signer' => 'string', + 'type' => 'string', 'x' => 'int', 'y' => 'int', 'width' => 'int', 'height' => 'int', 'required' => 'bool', + 'signer' => 'string', 'group' => 'string', ]; @@ -78,15 +78,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @psalm-var array */ protected static $openAPIFormats = [ - 'type' => null, 'api_id' => null, 'name' => null, - 'signer' => null, + 'type' => null, 'x' => null, 'y' => null, 'width' => null, 'height' => null, 'required' => null, + 'signer' => null, 'group' => null, ]; @@ -96,15 +96,15 @@ class TemplateResponseDocumentCustomFieldBase implements ModelInterface, ArrayAc * @var bool[] */ protected static array $openAPINullables = [ - 'type' => false, 'api_id' => false, 'name' => false, - 'signer' => true, + 'type' => false, 'x' => false, 'y' => false, 'width' => false, 'height' => false, 'required' => false, + 'signer' => true, 'group' => true, ]; @@ -186,15 +186,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', - 'signer' => 'signer', + 'type' => 'type', 'x' => 'x', 'y' => 'y', 'width' => 'width', 'height' => 'height', 'required' => 'required', + 'signer' => 'signer', 'group' => 'group', ]; @@ -204,15 +204,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', - 'signer' => 'setSigner', + 'type' => 'setType', 'x' => 'setX', 'y' => 'setY', 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', + 'signer' => 'setSigner', 'group' => 'setGroup', ]; @@ -222,15 +222,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', - 'signer' => 'getSigner', + 'type' => 'getType', 'x' => 'getX', 'y' => 'getY', 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', + 'signer' => 'getSigner', 'group' => 'getGroup', ]; @@ -290,15 +290,15 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); - $this->setIfExists('signer', $data ?? [], null); + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); $this->setIfExists('width', $data ?? [], null); $this->setIfExists('height', $data ?? [], null); $this->setIfExists('required', $data ?? [], null); + $this->setIfExists('signer', $data ?? [], null); $this->setIfExists('group', $data ?? [], null); // Initialize discriminator property with the model name. @@ -346,9 +346,30 @@ public function listInvalidProperties() { $invalidProperties = []; + if ($this->container['api_id'] === null) { + $invalidProperties[] = "'api_id' can't be null"; + } + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['x'] === null) { + $invalidProperties[] = "'x' can't be null"; + } + if ($this->container['y'] === null) { + $invalidProperties[] = "'y' can't be null"; + } + if ($this->container['width'] === null) { + $invalidProperties[] = "'width' can't be null"; + } + if ($this->container['height'] === null) { + $invalidProperties[] = "'height' can't be null"; + } + if ($this->container['required'] === null) { + $invalidProperties[] = "'required' can't be null"; + } return $invalidProperties; } @@ -363,37 +384,10 @@ public function valid() return count($this->listInvalidProperties()) === 0; } - /** - * Gets type - * - * @return string - */ - public function getType() - { - return $this->container['type']; - } - - /** - * Sets type - * - * @param string $type type - * - * @return self - */ - public function setType(string $type) - { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); - } - $this->container['type'] = $type; - - return $this; - } - /** * Gets api_id * - * @return string|null + * @return string */ public function getApiId() { @@ -403,11 +397,11 @@ public function getApiId() /** * Sets api_id * - * @param string|null $api_id the unique ID for this field + * @param string $api_id the unique ID for this field * * @return self */ - public function setApiId(?string $api_id) + public function setApiId(string $api_id) { if (is_null($api_id)) { throw new InvalidArgumentException('non-nullable api_id cannot be null'); @@ -420,7 +414,7 @@ public function setApiId(?string $api_id) /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -430,11 +424,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Custom Field + * @param string $name the name of the Custom Field * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -445,35 +439,28 @@ public function setName(?string $name) } /** - * Gets signer + * Gets type * - * @return string|null + * @return string */ - public function getSigner() + public function getType() { - return $this->container['signer']; + return $this->container['type']; } /** - * Sets signer + * Sets type * - * @param string|null $signer The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * @param string $type type * * @return self */ - public function setSigner(?string $signer) + public function setType(string $type) { - if (is_null($signer)) { - array_push($this->openAPINullablesSetToNull, 'signer'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('signer', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['signer'] = $signer; + $this->container['type'] = $type; return $this; } @@ -481,7 +468,7 @@ public function setSigner(?string $signer) /** * Gets x * - * @return int|null + * @return int */ public function getX() { @@ -491,11 +478,11 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int $x the horizontal offset in pixels for this form field * * @return self */ - public function setX(?int $x) + public function setX(int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -508,7 +495,7 @@ public function setX(?int $x) /** * Gets y * - * @return int|null + * @return int */ public function getY() { @@ -518,11 +505,11 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int $y the vertical offset in pixels for this form field * * @return self */ - public function setY(?int $y) + public function setY(int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -535,7 +522,7 @@ public function setY(?int $y) /** * Gets width * - * @return int|null + * @return int */ public function getWidth() { @@ -545,11 +532,11 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int $width the width in pixels of this form field * * @return self */ - public function setWidth(?int $width) + public function setWidth(int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -562,7 +549,7 @@ public function setWidth(?int $width) /** * Gets height * - * @return int|null + * @return int */ public function getHeight() { @@ -572,11 +559,11 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int $height the height in pixels of this form field * * @return self */ - public function setHeight(?int $height) + public function setHeight(int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -589,7 +576,7 @@ public function setHeight(?int $height) /** * Gets required * - * @return bool|null + * @return bool */ public function getRequired() { @@ -599,11 +586,11 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(?bool $required) + public function setRequired(bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); @@ -613,6 +600,40 @@ public function setRequired(?bool $required) return $this; } + /** + * Gets signer + * + * @return string|null + */ + public function getSigner() + { + return $this->container['signer']; + } + + /** + * Sets signer + * + * @param string|null $signer The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + * + * @return self + */ + public function setSigner(?string $signer) + { + if (is_null($signer)) { + array_push($this->openAPINullablesSetToNull, 'signer'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('signer', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['signer'] = $signer; + + return $this; + } + /** * Gets group * diff --git a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php index e63a73978..1ae1955b6 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentCustomFieldText.php @@ -308,6 +308,18 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['avg_text_length'] === null) { + $invalidProperties[] = "'avg_text_length' can't be null"; + } + if ($this->container['is_multiline'] === null) { + $invalidProperties[] = "'is_multiline' can't be null"; + } + if ($this->container['original_font_size'] === null) { + $invalidProperties[] = "'original_font_size' can't be null"; + } + if ($this->container['font_family'] === null) { + $invalidProperties[] = "'font_family' can't be null"; + } return $invalidProperties; } @@ -352,7 +364,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength */ public function getAvgTextLength() { @@ -362,11 +374,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -379,7 +391,7 @@ public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_l /** * Gets is_multiline * - * @return bool|null + * @return bool */ public function getIsMultiline() { @@ -389,11 +401,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline(bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -406,7 +418,7 @@ public function setIsMultiline(?bool $is_multiline) /** * Gets original_font_size * - * @return int|null + * @return int */ public function getOriginalFontSize() { @@ -416,11 +428,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize(int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -433,7 +445,7 @@ public function setOriginalFontSize(?int $original_font_size) /** * Gets font_family * - * @return string|null + * @return string */ public function getFontFamily() { @@ -443,11 +455,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily(string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php index 541714841..6c714950a 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroup.php @@ -288,7 +288,15 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + if ($this->container['rule'] === null) { + $invalidProperties[] = "'rule' can't be null"; + } + return $invalidProperties; } /** @@ -305,7 +313,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -315,11 +323,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the form field group + * @param string $name the name of the form field group * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); @@ -332,7 +340,7 @@ public function setName(?string $name) /** * Gets rule * - * @return TemplateResponseDocumentFieldGroupRule|null + * @return TemplateResponseDocumentFieldGroupRule */ public function getRule() { @@ -342,11 +350,11 @@ public function getRule() /** * Sets rule * - * @param TemplateResponseDocumentFieldGroupRule|null $rule rule + * @param TemplateResponseDocumentFieldGroupRule $rule rule * * @return self */ - public function setRule(?TemplateResponseDocumentFieldGroupRule $rule) + public function setRule(TemplateResponseDocumentFieldGroupRule $rule) { if (is_null($rule)) { throw new InvalidArgumentException('non-nullable rule cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php index 1bd31bde9..d46ce788b 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFieldGroupRule.php @@ -289,7 +289,15 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['requirement'] === null) { + $invalidProperties[] = "'requirement' can't be null"; + } + if ($this->container['group_label'] === null) { + $invalidProperties[] = "'group_label' can't be null"; + } + return $invalidProperties; } /** @@ -306,7 +314,7 @@ public function valid() /** * Gets requirement * - * @return string|null + * @return string */ public function getRequirement() { @@ -316,11 +324,11 @@ public function getRequirement() /** * Sets requirement * - * @param string|null $requirement Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. + * @param string $requirement Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. * * @return self */ - public function setRequirement(?string $requirement) + public function setRequirement(string $requirement) { if (is_null($requirement)) { throw new InvalidArgumentException('non-nullable requirement cannot be null'); @@ -333,7 +341,7 @@ public function setRequirement(?string $requirement) /** * Gets group_label * - * @return string|null + * @return string */ public function getGroupLabel() { @@ -343,11 +351,11 @@ public function getGroupLabel() /** * Sets group_label * - * @param string|null $group_label Name of the group + * @param string $group_label Name of the group * * @return self */ - public function setGroupLabel(?string $group_label) + public function setGroupLabel(string $group_label) { if (is_null($group_label)) { throw new InvalidArgumentException('non-nullable group_label cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php index 33cc52c58..cb72f6d81 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldBase.php @@ -58,16 +58,15 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @var string[] */ protected static $openAPITypes = [ - 'type' => 'string', 'api_id' => 'string', 'name' => 'string', + 'type' => 'string', 'signer' => 'string', 'x' => 'int', 'y' => 'int', 'width' => 'int', 'height' => 'int', 'required' => 'bool', - 'group' => 'string', ]; /** @@ -78,16 +77,15 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @psalm-var array */ protected static $openAPIFormats = [ - 'type' => null, 'api_id' => null, 'name' => null, + 'type' => null, 'signer' => null, 'x' => null, 'y' => null, 'width' => null, 'height' => null, 'required' => null, - 'group' => null, ]; /** @@ -96,16 +94,15 @@ class TemplateResponseDocumentFormFieldBase implements ModelInterface, ArrayAcce * @var bool[] */ protected static array $openAPINullables = [ - 'type' => false, 'api_id' => false, 'name' => false, + 'type' => false, 'signer' => false, 'x' => false, 'y' => false, 'width' => false, 'height' => false, 'required' => false, - 'group' => true, ]; /** @@ -186,16 +183,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', + 'type' => 'type', 'signer' => 'signer', 'x' => 'x', 'y' => 'y', 'width' => 'width', 'height' => 'height', 'required' => 'required', - 'group' => 'group', ]; /** @@ -204,16 +200,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', + 'type' => 'setType', 'signer' => 'setSigner', 'x' => 'setX', 'y' => 'setY', 'width' => 'setWidth', 'height' => 'setHeight', 'required' => 'setRequired', - 'group' => 'setGroup', ]; /** @@ -222,16 +217,15 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', + 'type' => 'getType', 'signer' => 'getSigner', 'x' => 'getX', 'y' => 'getY', 'width' => 'getWidth', 'height' => 'getHeight', 'required' => 'getRequired', - 'group' => 'getGroup', ]; /** @@ -290,16 +284,15 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('signer', $data ?? [], null); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); $this->setIfExists('width', $data ?? [], null); $this->setIfExists('height', $data ?? [], null); $this->setIfExists('required', $data ?? [], null); - $this->setIfExists('group', $data ?? [], null); // Initialize discriminator property with the model name. $this->container['type'] = static::$openAPIModelName; @@ -364,9 +357,33 @@ public function listInvalidProperties() { $invalidProperties = []; + if ($this->container['api_id'] === null) { + $invalidProperties[] = "'api_id' can't be null"; + } + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['signer'] === null) { + $invalidProperties[] = "'signer' can't be null"; + } + if ($this->container['x'] === null) { + $invalidProperties[] = "'x' can't be null"; + } + if ($this->container['y'] === null) { + $invalidProperties[] = "'y' can't be null"; + } + if ($this->container['width'] === null) { + $invalidProperties[] = "'width' can't be null"; + } + if ($this->container['height'] === null) { + $invalidProperties[] = "'height' can't be null"; + } + if ($this->container['required'] === null) { + $invalidProperties[] = "'required' can't be null"; + } return $invalidProperties; } @@ -382,82 +399,82 @@ public function valid() } /** - * Gets type + * Gets api_id * * @return string */ - public function getType() + public function getApiId() { - return $this->container['type']; + return $this->container['api_id']; } /** - * Sets type + * Sets api_id * - * @param string $type type + * @param string $api_id a unique id for the form field * * @return self */ - public function setType(string $type) + public function setApiId(string $api_id) { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + if (is_null($api_id)) { + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } - $this->container['type'] = $type; + $this->container['api_id'] = $api_id; return $this; } /** - * Gets api_id + * Gets name * - * @return string|null + * @return string */ - public function getApiId() + public function getName() { - return $this->container['api_id']; + return $this->container['name']; } /** - * Sets api_id + * Sets name * - * @param string|null $api_id a unique id for the form field + * @param string $name the name of the form field * * @return self */ - public function setApiId(?string $api_id) + public function setName(string $name) { - if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + if (is_null($name)) { + throw new InvalidArgumentException('non-nullable name cannot be null'); } - $this->container['api_id'] = $api_id; + $this->container['name'] = $name; return $this; } /** - * Gets name + * Gets type * - * @return string|null + * @return string */ - public function getName() + public function getType() { - return $this->container['name']; + return $this->container['type']; } /** - * Sets name + * Sets type * - * @param string|null $name the name of the form field + * @param string $type type * * @return self */ - public function setName(?string $name) + public function setType(string $type) { - if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['name'] = $name; + $this->container['type'] = $type; return $this; } @@ -465,7 +482,7 @@ public function setName(?string $name) /** * Gets signer * - * @return string|null + * @return string */ public function getSigner() { @@ -475,11 +492,11 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Form Field + * @param string $signer the signer of the Form Field * * @return self */ - public function setSigner(?string $signer) + public function setSigner(string $signer) { if (is_null($signer)) { throw new InvalidArgumentException('non-nullable signer cannot be null'); @@ -492,7 +509,7 @@ public function setSigner(?string $signer) /** * Gets x * - * @return int|null + * @return int */ public function getX() { @@ -502,11 +519,11 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this form field + * @param int $x the horizontal offset in pixels for this form field * * @return self */ - public function setX(?int $x) + public function setX(int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -519,7 +536,7 @@ public function setX(?int $x) /** * Gets y * - * @return int|null + * @return int */ public function getY() { @@ -529,11 +546,11 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this form field + * @param int $y the vertical offset in pixels for this form field * * @return self */ - public function setY(?int $y) + public function setY(int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -546,7 +563,7 @@ public function setY(?int $y) /** * Gets width * - * @return int|null + * @return int */ public function getWidth() { @@ -556,11 +573,11 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this form field + * @param int $width the width in pixels of this form field * * @return self */ - public function setWidth(?int $width) + public function setWidth(int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -573,7 +590,7 @@ public function setWidth(?int $width) /** * Gets height * - * @return int|null + * @return int */ public function getHeight() { @@ -583,11 +600,11 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this form field + * @param int $height the height in pixels of this form field * * @return self */ - public function setHeight(?int $height) + public function setHeight(int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -600,7 +617,7 @@ public function setHeight(?int $height) /** * Gets required * - * @return bool|null + * @return bool */ public function getRequired() { @@ -610,11 +627,11 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(?bool $required) + public function setRequired(bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); @@ -624,40 +641,6 @@ public function setRequired(?bool $required) return $this; } - /** - * Gets group - * - * @return string|null - */ - public function getGroup() - { - return $this->container['group']; - } - - /** - * Sets group - * - * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - * - * @return self - */ - public function setGroup(?string $group) - { - if (is_null($group)) { - array_push($this->openAPINullablesSetToNull, 'group'); - } else { - $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); - $index = array_search('group', $nullablesSetToNull); - if ($index !== false) { - unset($nullablesSetToNull[$index]); - $this->setOpenAPINullablesSetToNull($nullablesSetToNull); - } - } - $this->container['group'] = $group; - - return $this; - } - /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php index bd03254c4..a30010fc1 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldCheckbox.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocument */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'checkbox'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php index 158d8159c..bd6072350 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDateSigned.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocume */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'date_signed'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php index 057b5d84d..3e4a827da 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldDropdown.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocument */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'dropdown'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php index 81ffda0ce..0f232111f 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldHyperlink.php @@ -61,6 +61,7 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen 'is_multiline' => 'bool', 'original_font_size' => 'int', 'font_family' => 'string', + 'group' => 'string', ]; /** @@ -76,6 +77,7 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen 'is_multiline' => null, 'original_font_size' => null, 'font_family' => null, + 'group' => null, ]; /** @@ -89,6 +91,7 @@ class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumen 'is_multiline' => false, 'original_font_size' => false, 'font_family' => false, + 'group' => true, ]; /** @@ -174,6 +177,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'isMultiline', 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', + 'group' => 'group', ]; /** @@ -187,6 +191,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'setIsMultiline', 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', + 'group' => 'setGroup', ]; /** @@ -200,6 +205,7 @@ public function isNullableSetToNull(string $property): bool 'is_multiline' => 'getIsMultiline', 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', + 'group' => 'getGroup', ]; /** @@ -258,6 +264,7 @@ public function __construct(array $data = null) $this->setIfExists('is_multiline', $data ?? [], null); $this->setIfExists('original_font_size', $data ?? [], null); $this->setIfExists('font_family', $data ?? [], null); + $this->setIfExists('group', $data ?? [], null); } /** @@ -308,6 +315,18 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['avg_text_length'] === null) { + $invalidProperties[] = "'avg_text_length' can't be null"; + } + if ($this->container['is_multiline'] === null) { + $invalidProperties[] = "'is_multiline' can't be null"; + } + if ($this->container['original_font_size'] === null) { + $invalidProperties[] = "'original_font_size' can't be null"; + } + if ($this->container['font_family'] === null) { + $invalidProperties[] = "'font_family' can't be null"; + } return $invalidProperties; } @@ -352,7 +371,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength */ public function getAvgTextLength() { @@ -362,11 +381,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -379,7 +398,7 @@ public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_l /** * Gets is_multiline * - * @return bool|null + * @return bool */ public function getIsMultiline() { @@ -389,11 +408,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline(bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -406,7 +425,7 @@ public function setIsMultiline(?bool $is_multiline) /** * Gets original_font_size * - * @return int|null + * @return int */ public function getOriginalFontSize() { @@ -416,11 +435,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize(int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -433,7 +452,7 @@ public function setOriginalFontSize(?int $original_font_size) /** * Gets font_family * - * @return string|null + * @return string */ public function getFontFamily() { @@ -443,11 +462,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily(string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); @@ -457,6 +476,40 @@ public function setFontFamily(?string $font_family) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php index 976a27fba..101a6e955 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldInitials.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocument */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'initials'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php index bd0d28e85..8fd494678 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldRadio.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFor */ protected static array $openAPINullables = [ 'type' => false, + 'group' => false, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'radio'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -280,6 +287,9 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['group'] === null) { + $invalidProperties[] = "'group' can't be null"; + } return $invalidProperties; } @@ -321,6 +331,33 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(string $group) + { + if (is_null($group)) { + throw new InvalidArgumentException('non-nullable group cannot be null'); + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php index 9effb72b7..777777464 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldSignature.php @@ -57,6 +57,7 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen */ protected static $openAPITypes = [ 'type' => 'string', + 'group' => 'string', ]; /** @@ -68,6 +69,7 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen */ protected static $openAPIFormats = [ 'type' => null, + 'group' => null, ]; /** @@ -77,6 +79,7 @@ class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumen */ protected static array $openAPINullables = [ 'type' => false, + 'group' => true, ]; /** @@ -158,6 +161,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $attributeMap = [ 'type' => 'type', + 'group' => 'group', ]; /** @@ -167,6 +171,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $setters = [ 'type' => 'setType', + 'group' => 'setGroup', ]; /** @@ -176,6 +181,7 @@ public function isNullableSetToNull(string $property): bool */ protected static $getters = [ 'type' => 'getType', + 'group' => 'getGroup', ]; /** @@ -230,6 +236,7 @@ public function __construct(array $data = null) parent::__construct($data); $this->setIfExists('type', $data ?? [], 'signature'); + $this->setIfExists('group', $data ?? [], null); } /** @@ -321,6 +328,40 @@ public function setType(string $type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php index 0684e1d67..d8a69b6e0 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php +++ b/sdks/php/src/Model/TemplateResponseDocumentFormFieldText.php @@ -62,6 +62,7 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => 'int', 'font_family' => 'string', 'validation_type' => 'string', + 'group' => 'string', ]; /** @@ -78,6 +79,7 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => null, 'font_family' => null, 'validation_type' => null, + 'group' => null, ]; /** @@ -92,6 +94,7 @@ class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentForm 'original_font_size' => false, 'font_family' => false, 'validation_type' => true, + 'group' => true, ]; /** @@ -178,6 +181,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'originalFontSize', 'font_family' => 'fontFamily', 'validation_type' => 'validation_type', + 'group' => 'group', ]; /** @@ -192,6 +196,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'setOriginalFontSize', 'font_family' => 'setFontFamily', 'validation_type' => 'setValidationType', + 'group' => 'setGroup', ]; /** @@ -206,6 +211,7 @@ public function isNullableSetToNull(string $property): bool 'original_font_size' => 'getOriginalFontSize', 'font_family' => 'getFontFamily', 'validation_type' => 'getValidationType', + 'group' => 'getGroup', ]; /** @@ -297,6 +303,7 @@ public function __construct(array $data = null) $this->setIfExists('original_font_size', $data ?? [], null); $this->setIfExists('font_family', $data ?? [], null); $this->setIfExists('validation_type', $data ?? [], null); + $this->setIfExists('group', $data ?? [], null); } /** @@ -347,6 +354,18 @@ public function listInvalidProperties() if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['avg_text_length'] === null) { + $invalidProperties[] = "'avg_text_length' can't be null"; + } + if ($this->container['is_multiline'] === null) { + $invalidProperties[] = "'is_multiline' can't be null"; + } + if ($this->container['original_font_size'] === null) { + $invalidProperties[] = "'original_font_size' can't be null"; + } + if ($this->container['font_family'] === null) { + $invalidProperties[] = "'font_family' can't be null"; + } $allowedValues = $this->getValidationTypeAllowableValues(); if (!is_null($this->container['validation_type']) && !in_array($this->container['validation_type'], $allowedValues, true)) { $invalidProperties[] = sprintf( @@ -400,7 +419,7 @@ public function setType(string $type) /** * Gets avg_text_length * - * @return TemplateResponseFieldAvgTextLength|null + * @return TemplateResponseFieldAvgTextLength */ public function getAvgTextLength() { @@ -410,11 +429,11 @@ public function getAvgTextLength() /** * Sets avg_text_length * - * @param TemplateResponseFieldAvgTextLength|null $avg_text_length avg_text_length + * @param TemplateResponseFieldAvgTextLength $avg_text_length avg_text_length * * @return self */ - public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_length) + public function setAvgTextLength(TemplateResponseFieldAvgTextLength $avg_text_length) { if (is_null($avg_text_length)) { throw new InvalidArgumentException('non-nullable avg_text_length cannot be null'); @@ -427,7 +446,7 @@ public function setAvgTextLength(?TemplateResponseFieldAvgTextLength $avg_text_l /** * Gets is_multiline * - * @return bool|null + * @return bool */ public function getIsMultiline() { @@ -437,11 +456,11 @@ public function getIsMultiline() /** * Sets is_multiline * - * @param bool|null $is_multiline whether this form field is multiline text + * @param bool $is_multiline whether this form field is multiline text * * @return self */ - public function setIsMultiline(?bool $is_multiline) + public function setIsMultiline(bool $is_multiline) { if (is_null($is_multiline)) { throw new InvalidArgumentException('non-nullable is_multiline cannot be null'); @@ -454,7 +473,7 @@ public function setIsMultiline(?bool $is_multiline) /** * Gets original_font_size * - * @return int|null + * @return int */ public function getOriginalFontSize() { @@ -464,11 +483,11 @@ public function getOriginalFontSize() /** * Sets original_font_size * - * @param int|null $original_font_size original font size used in this form field's text + * @param int $original_font_size original font size used in this form field's text * * @return self */ - public function setOriginalFontSize(?int $original_font_size) + public function setOriginalFontSize(int $original_font_size) { if (is_null($original_font_size)) { throw new InvalidArgumentException('non-nullable original_font_size cannot be null'); @@ -481,7 +500,7 @@ public function setOriginalFontSize(?int $original_font_size) /** * Gets font_family * - * @return string|null + * @return string */ public function getFontFamily() { @@ -491,11 +510,11 @@ public function getFontFamily() /** * Sets font_family * - * @param string|null $font_family font family used in this form field's text + * @param string $font_family font family used in this form field's text * * @return self */ - public function setFontFamily(?string $font_family) + public function setFontFamily(string $font_family) { if (is_null($font_family)) { throw new InvalidArgumentException('non-nullable font_family cannot be null'); @@ -549,6 +568,40 @@ public function setValidationType(?string $validation_type) return $this; } + /** + * Gets group + * + * @return string|null + */ + public function getGroup() + { + return $this->container['group']; + } + + /** + * Sets group + * + * @param string|null $group The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + * + * @return self + */ + public function setGroup(?string $group) + { + if (is_null($group)) { + array_push($this->openAPINullablesSetToNull, 'group'); + } else { + $nullablesSetToNull = $this->getOpenAPINullablesSetToNull(); + $index = array_search('group', $nullablesSetToNull); + if ($index !== false) { + unset($nullablesSetToNull[$index]); + $this->setOpenAPINullablesSetToNull($nullablesSetToNull); + } + } + $this->container['group'] = $group; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php index bd18e1847..4536c117d 100644 --- a/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php +++ b/sdks/php/src/Model/TemplateResponseDocumentStaticFieldBase.php @@ -58,9 +58,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @var string[] */ protected static $openAPITypes = [ - 'type' => 'string', 'api_id' => 'string', 'name' => 'string', + 'type' => 'string', 'signer' => 'string', 'x' => 'int', 'y' => 'int', @@ -78,9 +78,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @psalm-var array */ protected static $openAPIFormats = [ - 'type' => null, 'api_id' => null, 'name' => null, + 'type' => null, 'signer' => null, 'x' => null, 'y' => null, @@ -96,9 +96,9 @@ class TemplateResponseDocumentStaticFieldBase implements ModelInterface, ArrayAc * @var bool[] */ protected static array $openAPINullables = [ - 'type' => false, 'api_id' => false, 'name' => false, + 'type' => false, 'signer' => false, 'x' => false, 'y' => false, @@ -186,9 +186,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $attributeMap = [ - 'type' => 'type', 'api_id' => 'api_id', 'name' => 'name', + 'type' => 'type', 'signer' => 'signer', 'x' => 'x', 'y' => 'y', @@ -204,9 +204,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $setters = [ - 'type' => 'setType', 'api_id' => 'setApiId', 'name' => 'setName', + 'type' => 'setType', 'signer' => 'setSigner', 'x' => 'setX', 'y' => 'setY', @@ -222,9 +222,9 @@ public function isNullableSetToNull(string $property): bool * @var string[] */ protected static $getters = [ - 'type' => 'getType', 'api_id' => 'getApiId', 'name' => 'getName', + 'type' => 'getType', 'signer' => 'getSigner', 'x' => 'getX', 'y' => 'getY', @@ -290,9 +290,9 @@ public function getModelName() */ public function __construct(array $data = null) { - $this->setIfExists('type', $data ?? [], null); $this->setIfExists('api_id', $data ?? [], null); $this->setIfExists('name', $data ?? [], null); + $this->setIfExists('type', $data ?? [], null); $this->setIfExists('signer', $data ?? [], 'me_now'); $this->setIfExists('x', $data ?? [], null); $this->setIfExists('y', $data ?? [], null); @@ -364,9 +364,33 @@ public function listInvalidProperties() { $invalidProperties = []; + if ($this->container['api_id'] === null) { + $invalidProperties[] = "'api_id' can't be null"; + } + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } if ($this->container['type'] === null) { $invalidProperties[] = "'type' can't be null"; } + if ($this->container['signer'] === null) { + $invalidProperties[] = "'signer' can't be null"; + } + if ($this->container['x'] === null) { + $invalidProperties[] = "'x' can't be null"; + } + if ($this->container['y'] === null) { + $invalidProperties[] = "'y' can't be null"; + } + if ($this->container['width'] === null) { + $invalidProperties[] = "'width' can't be null"; + } + if ($this->container['height'] === null) { + $invalidProperties[] = "'height' can't be null"; + } + if ($this->container['required'] === null) { + $invalidProperties[] = "'required' can't be null"; + } return $invalidProperties; } @@ -382,82 +406,82 @@ public function valid() } /** - * Gets type + * Gets api_id * * @return string */ - public function getType() + public function getApiId() { - return $this->container['type']; + return $this->container['api_id']; } /** - * Sets type + * Sets api_id * - * @param string $type type + * @param string $api_id a unique id for the static field * * @return self */ - public function setType(string $type) + public function setApiId(string $api_id) { - if (is_null($type)) { - throw new InvalidArgumentException('non-nullable type cannot be null'); + if (is_null($api_id)) { + throw new InvalidArgumentException('non-nullable api_id cannot be null'); } - $this->container['type'] = $type; + $this->container['api_id'] = $api_id; return $this; } /** - * Gets api_id + * Gets name * - * @return string|null + * @return string */ - public function getApiId() + public function getName() { - return $this->container['api_id']; + return $this->container['name']; } /** - * Sets api_id + * Sets name * - * @param string|null $api_id a unique id for the static field + * @param string $name the name of the static field * * @return self */ - public function setApiId(?string $api_id) + public function setName(string $name) { - if (is_null($api_id)) { - throw new InvalidArgumentException('non-nullable api_id cannot be null'); + if (is_null($name)) { + throw new InvalidArgumentException('non-nullable name cannot be null'); } - $this->container['api_id'] = $api_id; + $this->container['name'] = $name; return $this; } /** - * Gets name + * Gets type * - * @return string|null + * @return string */ - public function getName() + public function getType() { - return $this->container['name']; + return $this->container['type']; } /** - * Sets name + * Sets type * - * @param string|null $name the name of the static field + * @param string $type type * * @return self */ - public function setName(?string $name) + public function setType(string $type) { - if (is_null($name)) { - throw new InvalidArgumentException('non-nullable name cannot be null'); + if (is_null($type)) { + throw new InvalidArgumentException('non-nullable type cannot be null'); } - $this->container['name'] = $name; + $this->container['type'] = $type; return $this; } @@ -465,7 +489,7 @@ public function setName(?string $name) /** * Gets signer * - * @return string|null + * @return string */ public function getSigner() { @@ -475,11 +499,11 @@ public function getSigner() /** * Sets signer * - * @param string|null $signer the signer of the Static Field + * @param string $signer the signer of the Static Field * * @return self */ - public function setSigner(?string $signer) + public function setSigner(string $signer) { if (is_null($signer)) { throw new InvalidArgumentException('non-nullable signer cannot be null'); @@ -492,7 +516,7 @@ public function setSigner(?string $signer) /** * Gets x * - * @return int|null + * @return int */ public function getX() { @@ -502,11 +526,11 @@ public function getX() /** * Sets x * - * @param int|null $x the horizontal offset in pixels for this static field + * @param int $x the horizontal offset in pixels for this static field * * @return self */ - public function setX(?int $x) + public function setX(int $x) { if (is_null($x)) { throw new InvalidArgumentException('non-nullable x cannot be null'); @@ -519,7 +543,7 @@ public function setX(?int $x) /** * Gets y * - * @return int|null + * @return int */ public function getY() { @@ -529,11 +553,11 @@ public function getY() /** * Sets y * - * @param int|null $y the vertical offset in pixels for this static field + * @param int $y the vertical offset in pixels for this static field * * @return self */ - public function setY(?int $y) + public function setY(int $y) { if (is_null($y)) { throw new InvalidArgumentException('non-nullable y cannot be null'); @@ -546,7 +570,7 @@ public function setY(?int $y) /** * Gets width * - * @return int|null + * @return int */ public function getWidth() { @@ -556,11 +580,11 @@ public function getWidth() /** * Sets width * - * @param int|null $width the width in pixels of this static field + * @param int $width the width in pixels of this static field * * @return self */ - public function setWidth(?int $width) + public function setWidth(int $width) { if (is_null($width)) { throw new InvalidArgumentException('non-nullable width cannot be null'); @@ -573,7 +597,7 @@ public function setWidth(?int $width) /** * Gets height * - * @return int|null + * @return int */ public function getHeight() { @@ -583,11 +607,11 @@ public function getHeight() /** * Sets height * - * @param int|null $height the height in pixels of this static field + * @param int $height the height in pixels of this static field * * @return self */ - public function setHeight(?int $height) + public function setHeight(int $height) { if (is_null($height)) { throw new InvalidArgumentException('non-nullable height cannot be null'); @@ -600,7 +624,7 @@ public function setHeight(?int $height) /** * Gets required * - * @return bool|null + * @return bool */ public function getRequired() { @@ -610,11 +634,11 @@ public function getRequired() /** * Sets required * - * @param bool|null $required boolean showing whether or not this field is required + * @param bool $required boolean showing whether or not this field is required * * @return self */ - public function setRequired(?bool $required) + public function setRequired(bool $required) { if (is_null($required)) { throw new InvalidArgumentException('non-nullable required cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php index 9277db26a..f43ee698c 100644 --- a/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php +++ b/sdks/php/src/Model/TemplateResponseFieldAvgTextLength.php @@ -289,7 +289,15 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['num_lines'] === null) { + $invalidProperties[] = "'num_lines' can't be null"; + } + if ($this->container['num_chars_per_line'] === null) { + $invalidProperties[] = "'num_chars_per_line' can't be null"; + } + return $invalidProperties; } /** @@ -306,7 +314,7 @@ public function valid() /** * Gets num_lines * - * @return int|null + * @return int */ public function getNumLines() { @@ -316,11 +324,11 @@ public function getNumLines() /** * Sets num_lines * - * @param int|null $num_lines number of lines + * @param int $num_lines number of lines * * @return self */ - public function setNumLines(?int $num_lines) + public function setNumLines(int $num_lines) { if (is_null($num_lines)) { throw new InvalidArgumentException('non-nullable num_lines cannot be null'); @@ -333,7 +341,7 @@ public function setNumLines(?int $num_lines) /** * Gets num_chars_per_line * - * @return int|null + * @return int */ public function getNumCharsPerLine() { @@ -343,11 +351,11 @@ public function getNumCharsPerLine() /** * Sets num_chars_per_line * - * @param int|null $num_chars_per_line number of characters per line + * @param int $num_chars_per_line number of characters per line * * @return self */ - public function setNumCharsPerLine(?int $num_chars_per_line) + public function setNumCharsPerLine(int $num_chars_per_line) { if (is_null($num_chars_per_line)) { throw new InvalidArgumentException('non-nullable num_chars_per_line cannot be null'); diff --git a/sdks/php/src/Model/TemplateResponseSignerRole.php b/sdks/php/src/Model/TemplateResponseSignerRole.php index 98a80c6e0..094e01375 100644 --- a/sdks/php/src/Model/TemplateResponseSignerRole.php +++ b/sdks/php/src/Model/TemplateResponseSignerRole.php @@ -288,7 +288,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['name'] === null) { + $invalidProperties[] = "'name' can't be null"; + } + return $invalidProperties; } /** @@ -305,7 +310,7 @@ public function valid() /** * Gets name * - * @return string|null + * @return string */ public function getName() { @@ -315,11 +320,11 @@ public function getName() /** * Sets name * - * @param string|null $name the name of the Role + * @param string $name the name of the Role * * @return self */ - public function setName(?string $name) + public function setName(string $name) { if (is_null($name)) { throw new InvalidArgumentException('non-nullable name cannot be null'); diff --git a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php index 70d2e87dc..f3df49b86 100644 --- a/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php +++ b/sdks/php/src/Model/TemplateUpdateFilesResponseTemplate.php @@ -289,7 +289,12 @@ private function setIfExists(string $variableName, array $fields, $defaultValue) */ public function listInvalidProperties() { - return []; + $invalidProperties = []; + + if ($this->container['template_id'] === null) { + $invalidProperties[] = "'template_id' can't be null"; + } + return $invalidProperties; } /** @@ -306,7 +311,7 @@ public function valid() /** * Gets template_id * - * @return string|null + * @return string */ public function getTemplateId() { @@ -316,11 +321,11 @@ public function getTemplateId() /** * Sets template_id * - * @param string|null $template_id the id of the Template + * @param string $template_id the id of the Template * * @return self */ - public function setTemplateId(?string $template_id) + public function setTemplateId(string $template_id) { if (is_null($template_id)) { throw new InvalidArgumentException('non-nullable template_id cannot be null'); diff --git a/sdks/python/docs/OAuthApi.md b/sdks/python/docs/OAuthApi.md index b26775683..969109c45 100644 --- a/sdks/python/docs/OAuthApi.md +++ b/sdks/python/docs/OAuthApi.md @@ -67,7 +67,6 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -**4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -127,7 +126,6 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| -**4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/sdks/python/docs/OAuthTokenRefreshRequest.md b/sdks/python/docs/OAuthTokenRefreshRequest.md index 87662c9e1..9322c48d6 100644 --- a/sdks/python/docs/OAuthTokenRefreshRequest.md +++ b/sdks/python/docs/OAuthTokenRefreshRequest.md @@ -7,8 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grant_type`*_required_ | ```str``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```str``` | The token provided when you got the expired access token. | | -| `client_id` | ```str``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | -| `client_secret` | ```str``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 56b48ec48..b8801fb09 100644 --- a/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -5,9 +5,9 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | -| `edit_url` | ```str``` | Link to edit the template. | | -| `expires_at` | ```int``` | When the link expires. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | +| `edit_url`*_required_ | ```str``` | Link to edit the template. | | +| `expires_at`*_required_ | ```int``` | When the link expires. | | | `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | [[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/TemplateCreateResponseTemplate.md b/sdks/python/docs/TemplateCreateResponseTemplate.md index 1c3d76f37..8281fab89 100644 --- a/sdks/python/docs/TemplateCreateResponseTemplate.md +++ b/sdks/python/docs/TemplateCreateResponseTemplate.md @@ -5,7 +5,7 @@ Template object with parameters: `template_id`. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index 7fb5cedbc..5cc6185f8 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -5,21 +5,22 @@ Contains information about the templates you and your team have created. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | -| `title` | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | +| `title`*_required_ | ```str``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```str``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `documents`*_required_ | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | | `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `is_creator` | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | | `metadata` | ```object``` | The metadata attached to the template. | | | `signer_roles` | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | | `cc_roles` | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | [[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/TemplateResponseAccount.md b/sdks/python/docs/TemplateResponseAccount.md index 7668fc726..da824a979 100644 --- a/sdks/python/docs/TemplateResponseAccount.md +++ b/sdks/python/docs/TemplateResponseAccount.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `account_id` | ```str``` | The id of the Account. | | +| `account_id`*_required_ | ```str``` | The id of the Account. | | +| `is_locked`*_required_ | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs`*_required_ | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf`*_required_ | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | | `email_address` | ```str``` | The email address associated with the Account. | | -| `is_locked` | ```bool``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```bool``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```bool``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseAccountQuota.md b/sdks/python/docs/TemplateResponseAccountQuota.md index 7e83dcc11..18ab10015 100644 --- a/sdks/python/docs/TemplateResponseAccountQuota.md +++ b/sdks/python/docs/TemplateResponseAccountQuota.md @@ -5,10 +5,10 @@ An array of the designated CC roles that must be specified when sending a Signat ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `templates_left` | ```int``` | API templates remaining. | | -| `api_signature_requests_left` | ```int``` | API signature requests remaining. | | -| `documents_left` | ```int``` | Signature requests remaining. | | -| `sms_verifications_left` | ```int``` | SMS verifications remaining. | | +| `templates_left`*_required_ | ```int``` | API templates remaining. | | +| `api_signature_requests_left`*_required_ | ```int``` | API signature requests remaining. | | +| `documents_left`*_required_ | ```int``` | Signature requests remaining. | | +| `sms_verifications_left`*_required_ | ```int``` | SMS verifications remaining. | | [[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/TemplateResponseCCRole.md b/sdks/python/docs/TemplateResponseCCRole.md index 1aa9fa707..81fe0a22d 100644 --- a/sdks/python/docs/TemplateResponseCCRole.md +++ b/sdks/python/docs/TemplateResponseCCRole.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the Role. | | +| `name`*_required_ | ```str``` | The name of the Role. | | [[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/TemplateResponseDocument.md b/sdks/python/docs/TemplateResponseDocument.md index 8071995b9..6ce6cded9 100644 --- a/sdks/python/docs/TemplateResponseDocument.md +++ b/sdks/python/docs/TemplateResponseDocument.md @@ -5,12 +5,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | Name of the associated file. | | +| `name`*_required_ | ```str``` | Name of the associated file. | | +| `field_groups`*_required_ | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields`*_required_ | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields`*_required_ | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields`*_required_ | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```int``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```List[TemplateResponseDocumentFieldGroup]```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```List[TemplateResponseDocumentStaticFieldBase]```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | [[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/TemplateResponseDocumentCustomFieldBase.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md index 83354a3f4..802b74749 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldBase.md @@ -5,15 +5,15 @@ An array of Form Field objects containing the name and type of each named field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```str``` | The unique ID for this field. | | +| `name`*_required_ | ```str``` | The name of the Custom Field. | | | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | The unique ID for this field. | | -| `name` | ```str``` | The name of the Custom Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `signer` | ```str``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseDocumentCustomFieldText.md b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md index 474097e03..35f8038d8 100644 --- a/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentCustomFieldText.md @@ -6,10 +6,10 @@ This class extends `TemplateResponseDocumentCustomFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | [[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/TemplateResponseDocumentFieldGroup.md b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md index 29a19c7cf..718a3e198 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroup.md @@ -5,8 +5,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```str``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md index 3f0a44f1a..2b44ba01e 100644 --- a/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/python/docs/TemplateResponseDocumentFieldGroupRule.md @@ -5,8 +5,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `requirement` | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label` | ```str``` | Name of the group | | +| `requirement`*_required_ | ```str``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label`*_required_ | ```str``` | Name of the group | | [[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/TemplateResponseDocumentFormFieldBase.md b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md index b8aecfa10..fa864f418 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldBase.md @@ -5,16 +5,15 @@ An array of Form Field objects containing the name and type of each named field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```str``` | A unique id for the form field. | | +| `name`*_required_ | ```str``` | The name of the form field. | | | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | A unique id for the form field. | | -| `name` | ```str``` | The name of the form field. | | -| `signer` | ```str``` | The signer of the Form Field. | | -| `x` | ```int``` | The horizontal offset in pixels for this form field. | | -| `y` | ```int``` | The vertical offset in pixels for this form field. | | -| `width` | ```int``` | The width in pixels of this form field. | | -| `height` | ```int``` | The height in pixels of this form field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | -| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```str``` | The signer of the Form Field. | | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```int``` | The width in pixels of this form field. | | +| `height`*_required_ | ```int``` | The height in pixels of this form field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | [[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/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md index 6d35e1c71..1a2167a2e 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md index 863ed1190..a9add1a93 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldDropdown.md b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md index 99d07332c..40d2cf2c0 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md index dd7db8dde..574f277e4 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -6,10 +6,11 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldInitials.md b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md index 80cc52231..77acaa80b 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldInitials.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldRadio.md b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md index af3e60ed9..9db9a8d03 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldRadio.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldSignature.md b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md index 304eaf502..adce267f0 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldSignature.md @@ -6,6 +6,7 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentFormFieldText.md b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md index bafb6e36b..b1c58101f 100644 --- a/sdks/python/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/python/docs/TemplateResponseDocumentFormFieldText.md @@ -6,11 +6,12 @@ This class extends `TemplateResponseDocumentFormFieldBase` Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `type`*_required_ | ```str``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```bool``` | Whether this form field is multiline text. | | -| `original_font_size` | ```int``` | Original font size used in this form field's text. | | -| `font_family` | ```str``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```bool``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```int``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```str``` | Font family used in this form field's text. | | | `validation_type` | ```str``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | [[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/TemplateResponseDocumentStaticFieldBase.md b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md index a7347b687..39a2be0f7 100644 --- a/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/python/docs/TemplateResponseDocumentStaticFieldBase.md @@ -5,15 +5,15 @@ An array describing static overlay fields. **NOTE:** Only available for certain ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +| `api_id`*_required_ | ```str``` | A unique id for the static field. | | +| `name`*_required_ | ```str``` | The name of the static field. | | | `type`*_required_ | ```str``` | | | -| `api_id` | ```str``` | A unique id for the static field. | | -| `name` | ```str``` | The name of the static field. | | -| `signer` | ```str``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```int``` | The horizontal offset in pixels for this static field. | | -| `y` | ```int``` | The vertical offset in pixels for this static field. | | -| `width` | ```int``` | The width in pixels of this static field. | | -| `height` | ```int``` | The height in pixels of this static field. | | -| `required` | ```bool``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```str``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```int``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```int``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```int``` | The width in pixels of this static field. | | +| `height`*_required_ | ```int``` | The height in pixels of this static field. | | +| `required`*_required_ | ```bool``` | Boolean showing whether or not this field is required. | | | `group` | ```str``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | [[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/TemplateResponseFieldAvgTextLength.md b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md index f50991c74..7cb7f1475 100644 --- a/sdks/python/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/python/docs/TemplateResponseFieldAvgTextLength.md @@ -5,8 +5,8 @@ Average text length in this field. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `num_lines` | ```int``` | Number of lines. | | -| `num_chars_per_line` | ```int``` | Number of characters per line. | | +| `num_lines`*_required_ | ```int``` | Number of lines. | | +| `num_chars_per_line`*_required_ | ```int``` | Number of characters per line. | | [[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/TemplateResponseSignerRole.md b/sdks/python/docs/TemplateResponseSignerRole.md index 7a65a361d..75bd84379 100644 --- a/sdks/python/docs/TemplateResponseSignerRole.md +++ b/sdks/python/docs/TemplateResponseSignerRole.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `name` | ```str``` | The name of the Role. | | +| `name`*_required_ | ```str``` | The name of the Role. | | | `order` | ```int``` | If signer order is assigned this is the 0-based index for this role. | | [[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/TemplateUpdateFilesResponseTemplate.md b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md index 27ea3171f..fbd42b28c 100644 --- a/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/python/docs/TemplateUpdateFilesResponseTemplate.md @@ -5,7 +5,7 @@ Contains template id ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `template_id` | ```str``` | The id of the Template. | | +| `template_id`*_required_ | ```str``` | The id of the Template. | | | `warnings` | [```List[WarningResponse]```](WarningResponse.md) | A list of warnings. | | [[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/o_auth_api.py b/sdks/python/dropbox_sign/api/o_auth_api.py index bedd1bfff..d5035a186 100644 --- a/sdks/python/dropbox_sign/api/o_auth_api.py +++ b/sdks/python/dropbox_sign/api/o_auth_api.py @@ -93,7 +93,6 @@ def oauth_token_generate( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", - "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -158,7 +157,6 @@ def oauth_token_generate_with_http_info( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", - "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -223,7 +221,6 @@ def oauth_token_generate_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", - "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -369,7 +366,6 @@ def oauth_token_refresh( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", - "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -434,7 +430,6 @@ def oauth_token_refresh_with_http_info( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", - "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -499,7 +494,6 @@ def oauth_token_refresh_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", - "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout 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 573036386..09535d939 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 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -38,20 +38,7 @@ class OAuthTokenRefreshRequest(BaseModel): refresh_token: StrictStr = Field( description="The token provided when you got the expired access token." ) - client_id: Optional[StrictStr] = Field( - default=None, - description='The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.', - ) - client_secret: Optional[StrictStr] = Field( - default=None, - description='The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.', - ) - __properties: ClassVar[List[str]] = [ - "grant_type", - "refresh_token", - "client_id", - "client_secret", - ] + __properties: ClassVar[List[str]] = ["grant_type", "refresh_token"] model_config = ConfigDict( populate_by_name=True, @@ -122,8 +109,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else "refresh_token" ), "refresh_token": obj.get("refresh_token"), - "client_id": obj.get("client_id"), - "client_secret": obj.get("client_secret"), } ) return _obj @@ -143,8 +128,6 @@ def openapi_types(cls) -> Dict[str, str]: return { "grant_type": "(str,)", "refresh_token": "(str,)", - "client_id": "(str,)", - "client_secret": "(str,)", } @classmethod 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 be23c205a..bc66784aa 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 @@ -33,15 +33,9 @@ class TemplateCreateEmbeddedDraftResponseTemplate(BaseModel): Template object with parameters: `template_id`, `edit_url`, `expires_at`. """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." - ) - edit_url: Optional[StrictStr] = Field( - default=None, description="Link to edit the template." - ) - expires_at: Optional[StrictInt] = Field( - default=None, description="When the link expires." - ) + template_id: StrictStr = Field(description="The id of the Template.") + edit_url: StrictStr = Field(description="Link to edit the template.") + expires_at: StrictInt = Field(description="When the link expires.") warnings: Optional[List[WarningResponse]] = Field( default=None, description="A list of warnings." ) 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 e4f253ef0..77253dcd3 100644 --- a/sdks/python/dropbox_sign/models/template_create_response_template.py +++ b/sdks/python/dropbox_sign/models/template_create_response_template.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -32,9 +32,7 @@ class TemplateCreateResponseTemplate(BaseModel): Template object with parameters: `template_id`. """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." - ) + template_id: StrictStr = Field(description="The id of the Template.") __properties: ClassVar[List[str]] = ["template_id"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index 12d203c42..e77c7534a 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -20,6 +20,9 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from dropbox_sign.models.signature_request_response_attachment import ( + SignatureRequestResponseAttachment, +) from dropbox_sign.models.template_response_account import TemplateResponseAccount from dropbox_sign.models.template_response_cc_role import TemplateResponseCCRole from dropbox_sign.models.template_response_document import TemplateResponseDocument @@ -42,16 +45,30 @@ class TemplateResponse(BaseModel): Contains information about the templates you and your team have created. """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." + template_id: StrictStr = Field(description="The id of the Template.") + title: StrictStr = Field( + description="The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest." ) - title: Optional[StrictStr] = Field( - default=None, - description="The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", + message: StrictStr = Field( + description="The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest." ) - message: Optional[StrictStr] = Field( - default=None, - description="The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.", + is_creator: StrictBool = Field( + description="`true` if you are the owner of this template, `false` if it's been shared with you by a team member." + ) + can_edit: StrictBool = Field( + description="Indicates whether edit rights have been granted to you by the owner (always `true` if that's you)." + ) + is_locked: StrictBool = Field( + description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests." + ) + documents: List[TemplateResponseDocument] = Field( + description="An array describing each document associated with this Template. Includes form field data for each document." + ) + accounts: List[TemplateResponseAccount] = Field( + description="An array of the Accounts that can use this Template." + ) + attachments: List[SignatureRequestResponseAttachment] = Field( + description="Signer attachments." ) updated_at: Optional[StrictInt] = Field( default=None, description="Time the template was last updated." @@ -60,18 +77,6 @@ class TemplateResponse(BaseModel): default=None, description="`true` if this template was created using an embedded flow, `false` if it was created on our website.", ) - is_creator: Optional[StrictBool] = Field( - default=None, - description="`true` if you are the owner of this template, `false` if it's been shared with you by a team member.", - ) - can_edit: Optional[StrictBool] = Field( - default=None, - description="Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).", - ) - is_locked: Optional[StrictBool] = Field( - default=None, - description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.", - ) metadata: Optional[Dict[str, Any]] = Field( default=None, description="The metadata attached to the template." ) @@ -83,10 +88,6 @@ class TemplateResponse(BaseModel): default=None, description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.", ) - documents: Optional[List[TemplateResponseDocument]] = Field( - default=None, - description="An array describing each document associated with this Template. Includes form field data for each document.", - ) custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( default=None, description="Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.", @@ -95,25 +96,23 @@ class TemplateResponse(BaseModel): default=None, description="Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.", ) - accounts: Optional[List[TemplateResponseAccount]] = Field( - default=None, description="An array of the Accounts that can use this Template." - ) __properties: ClassVar[List[str]] = [ "template_id", "title", "message", - "updated_at", - "is_embedded", "is_creator", "can_edit", "is_locked", + "documents", + "accounts", + "attachments", + "updated_at", + "is_embedded", "metadata", "signer_roles", "cc_roles", - "documents", "custom_fields", "named_form_fields", - "accounts", ] model_config = ConfigDict( @@ -166,6 +165,27 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of each item in documents (list) + _items = [] + if self.documents: + for _item_documents in self.documents: + if _item_documents: + _items.append(_item_documents.to_dict()) + _dict["documents"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in accounts (list) + _items = [] + if self.accounts: + for _item_accounts in self.accounts: + if _item_accounts: + _items.append(_item_accounts.to_dict()) + _dict["accounts"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in attachments (list) + _items = [] + if self.attachments: + for _item_attachments in self.attachments: + if _item_attachments: + _items.append(_item_attachments.to_dict()) + _dict["attachments"] = _items # override the default output from pydantic by calling `to_dict()` of each item in signer_roles (list) _items = [] if self.signer_roles: @@ -180,13 +200,6 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_cc_roles: _items.append(_item_cc_roles.to_dict()) _dict["cc_roles"] = _items - # override the default output from pydantic by calling `to_dict()` of each item in documents (list) - _items = [] - if self.documents: - for _item_documents in self.documents: - if _item_documents: - _items.append(_item_documents.to_dict()) - _dict["documents"] = _items # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) _items = [] if self.custom_fields: @@ -201,13 +214,6 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_named_form_fields: _items.append(_item_named_form_fields.to_dict()) _dict["named_form_fields"] = _items - # override the default output from pydantic by calling `to_dict()` of each item in accounts (list) - _items = [] - if self.accounts: - for _item_accounts in self.accounts: - if _item_accounts: - _items.append(_item_accounts.to_dict()) - _dict["accounts"] = _items return _dict @classmethod @@ -224,11 +230,35 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "template_id": obj.get("template_id"), "title": obj.get("title"), "message": obj.get("message"), - "updated_at": obj.get("updated_at"), - "is_embedded": obj.get("is_embedded"), "is_creator": obj.get("is_creator"), "can_edit": obj.get("can_edit"), "is_locked": obj.get("is_locked"), + "documents": ( + [ + TemplateResponseDocument.from_dict(_item) + for _item in obj["documents"] + ] + if obj.get("documents") is not None + else None + ), + "accounts": ( + [ + TemplateResponseAccount.from_dict(_item) + for _item in obj["accounts"] + ] + if obj.get("accounts") is not None + else None + ), + "attachments": ( + [ + SignatureRequestResponseAttachment.from_dict(_item) + for _item in obj["attachments"] + ] + if obj.get("attachments") is not None + else None + ), + "updated_at": obj.get("updated_at"), + "is_embedded": obj.get("is_embedded"), "metadata": obj.get("metadata"), "signer_roles": ( [ @@ -246,14 +276,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("cc_roles") is not None else None ), - "documents": ( - [ - TemplateResponseDocument.from_dict(_item) - for _item in obj["documents"] - ] - if obj.get("documents") is not None - else None - ), "custom_fields": ( [ TemplateResponseDocumentCustomFieldBase.from_dict(_item) @@ -270,14 +292,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("named_form_fields") is not None else None ), - "accounts": ( - [ - TemplateResponseAccount.from_dict(_item) - for _item in obj["accounts"] - ] - if obj.get("accounts") is not None - else None - ), } ) return _obj @@ -298,27 +312,29 @@ def openapi_types(cls) -> Dict[str, str]: "template_id": "(str,)", "title": "(str,)", "message": "(str,)", - "updated_at": "(int,)", - "is_embedded": "(bool,)", "is_creator": "(bool,)", "can_edit": "(bool,)", "is_locked": "(bool,)", + "documents": "(List[TemplateResponseDocument],)", + "accounts": "(List[TemplateResponseAccount],)", + "attachments": "(List[SignatureRequestResponseAttachment],)", + "updated_at": "(int,)", + "is_embedded": "(bool,)", "metadata": "(object,)", "signer_roles": "(List[TemplateResponseSignerRole],)", "cc_roles": "(List[TemplateResponseCCRole],)", - "documents": "(List[TemplateResponseDocument],)", "custom_fields": "(List[TemplateResponseDocumentCustomFieldBase],)", "named_form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", - "accounts": "(List[TemplateResponseAccount],)", } @classmethod def openapi_type_is_array(cls, property_name: str) -> bool: return property_name in [ + "documents", + "accounts", + "attachments", "signer_roles", "cc_roles", - "documents", "custom_fields", "named_form_fields", - "accounts", ] diff --git a/sdks/python/dropbox_sign/models/template_response_account.py b/sdks/python/dropbox_sign/models/template_response_account.py index 71358ff84..1b34f5e00 100644 --- a/sdks/python/dropbox_sign/models/template_response_account.py +++ b/sdks/python/dropbox_sign/models/template_response_account.py @@ -35,32 +35,27 @@ class TemplateResponseAccount(BaseModel): TemplateResponseAccount """ # noqa: E501 - account_id: Optional[StrictStr] = Field( - default=None, description="The id of the Account." + account_id: StrictStr = Field(description="The id of the Account.") + is_locked: StrictBool = Field( + description="Returns `true` if the user has been locked out of their account by a team admin." ) - email_address: Optional[StrictStr] = Field( - default=None, description="The email address associated with the Account." - ) - is_locked: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has been locked out of their account by a team admin.", + is_paid_hs: StrictBool = Field( + description="Returns `true` if the user has a paid Dropbox Sign account." ) - is_paid_hs: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid Dropbox Sign account.", + is_paid_hf: StrictBool = Field( + description="Returns `true` if the user has a paid HelloFax account." ) - is_paid_hf: Optional[StrictBool] = Field( - default=None, - description="Returns `true` if the user has a paid HelloFax account.", + quotas: TemplateResponseAccountQuota + email_address: Optional[StrictStr] = Field( + default=None, description="The email address associated with the Account." ) - quotas: Optional[TemplateResponseAccountQuota] = None __properties: ClassVar[List[str]] = [ "account_id", - "email_address", "is_locked", "is_paid_hs", "is_paid_hf", "quotas", + "email_address", ] model_config = ConfigDict( @@ -130,7 +125,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "account_id": obj.get("account_id"), - "email_address": obj.get("email_address"), "is_locked": obj.get("is_locked"), "is_paid_hs": obj.get("is_paid_hs"), "is_paid_hf": obj.get("is_paid_hf"), @@ -139,6 +133,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("quotas") is not None else None ), + "email_address": obj.get("email_address"), } ) return _obj @@ -157,11 +152,11 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "account_id": "(str,)", - "email_address": "(str,)", "is_locked": "(bool,)", "is_paid_hs": "(bool,)", "is_paid_hf": "(bool,)", "quotas": "(TemplateResponseAccountQuota,)", + "email_address": "(str,)", } @classmethod 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 6c03effe9..6c96e8cd7 100644 --- a/sdks/python/dropbox_sign/models/template_response_account_quota.py +++ b/sdks/python/dropbox_sign/models/template_response_account_quota.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictInt -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -32,17 +32,13 @@ class TemplateResponseAccountQuota(BaseModel): An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. """ # noqa: E501 - templates_left: Optional[StrictInt] = Field( - default=None, description="API templates remaining." + templates_left: StrictInt = Field(description="API templates remaining.") + api_signature_requests_left: StrictInt = Field( + description="API signature requests remaining." ) - api_signature_requests_left: Optional[StrictInt] = Field( - default=None, description="API signature requests remaining." - ) - documents_left: Optional[StrictInt] = Field( - default=None, description="Signature requests remaining." - ) - sms_verifications_left: Optional[StrictInt] = Field( - default=None, description="SMS verifications remaining." + documents_left: StrictInt = Field(description="Signature requests remaining.") + sms_verifications_left: StrictInt = Field( + description="SMS verifications remaining." ) __properties: ClassVar[List[str]] = [ "templates_left", 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 8c005227d..2a9e77900 100644 --- a/sdks/python/dropbox_sign/models/template_response_cc_role.py +++ b/sdks/python/dropbox_sign/models/template_response_cc_role.py @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -32,7 +32,7 @@ class TemplateResponseCCRole(BaseModel): TemplateResponseCCRole """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") + name: StrictStr = Field(description="The name of the Role.") __properties: ClassVar[List[str]] = ["name"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/template_response_document.py b/sdks/python/dropbox_sign/models/template_response_document.py index 56e887bd0..e7b4be883 100644 --- a/sdks/python/dropbox_sign/models/template_response_document.py +++ b/sdks/python/dropbox_sign/models/template_response_document.py @@ -44,35 +44,30 @@ class TemplateResponseDocument(BaseModel): TemplateResponseDocument """ # noqa: E501 - name: Optional[StrictStr] = Field( - default=None, description="Name of the associated file." + name: StrictStr = Field(description="Name of the associated file.") + field_groups: List[TemplateResponseDocumentFieldGroup] = Field( + description="An array of Form Field Group objects." ) - index: Optional[StrictInt] = Field( - default=None, - description="Document ordering, the lowest index is displayed first and the highest last (0-based indexing).", + form_fields: List[TemplateResponseDocumentFormFieldBase] = Field( + description="An array of Form Field objects containing the name and type of each named field." ) - field_groups: Optional[List[TemplateResponseDocumentFieldGroup]] = Field( - default=None, description="An array of Form Field Group objects." + custom_fields: List[TemplateResponseDocumentCustomFieldBase] = Field( + description="An array of Form Field objects containing the name and type of each named field." ) - form_fields: Optional[List[TemplateResponseDocumentFormFieldBase]] = Field( - default=None, - description="An array of Form Field objects containing the name and type of each named field.", + static_fields: List[TemplateResponseDocumentStaticFieldBase] = Field( + description="An array describing static overlay fields. **NOTE:** Only available for certain subscriptions." ) - custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( - default=None, - description="An array of Form Field objects containing the name and type of each named field.", - ) - static_fields: Optional[List[TemplateResponseDocumentStaticFieldBase]] = Field( + index: Optional[StrictInt] = Field( default=None, - description="An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.", + description="Document ordering, the lowest index is displayed first and the highest last (0-based indexing).", ) __properties: ClassVar[List[str]] = [ "name", - "index", "field_groups", "form_fields", "custom_fields", "static_fields", + "index", ] model_config = ConfigDict( @@ -167,7 +162,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { "name": obj.get("name"), - "index": obj.get("index"), "field_groups": ( [ TemplateResponseDocumentFieldGroup.from_dict(_item) @@ -200,6 +194,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("static_fields") is not None else None ), + "index": obj.get("index"), } ) return _obj @@ -218,11 +213,11 @@ def init(cls, data: Any) -> Self: def openapi_types(cls) -> Dict[str, str]: return { "name": "(str,)", - "index": "(int,)", "field_groups": "(List[TemplateResponseDocumentFieldGroup],)", "form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", "custom_fields": "(List[TemplateResponseDocumentCustomFieldBase],)", "static_fields": "(List[TemplateResponseDocumentStaticFieldBase],)", + "index": "(int,)", } @classmethod 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 a7d2fa60c..988002152 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 @@ -43,46 +43,37 @@ class TemplateResponseDocumentCustomFieldBase(BaseModel): An array of Form Field objects containing the name and type of each named field. """ # noqa: E501 + api_id: StrictStr = Field(description="The unique ID for this field.") + name: StrictStr = Field(description="The name of the Custom Field.") type: StrictStr - api_id: Optional[StrictStr] = Field( - default=None, description="The unique ID for this field." + x: StrictInt = Field( + description="The horizontal offset in pixels for this form field." ) - name: Optional[StrictStr] = Field( - default=None, description="The name of the Custom Field." + y: StrictInt = Field( + description="The vertical offset in pixels for this form field." + ) + width: StrictInt = Field(description="The width in pixels of this form field.") + height: StrictInt = Field(description="The height in pixels of this form field.") + required: StrictBool = Field( + description="Boolean showing whether or not this field is required." ) signer: Union[StrictStr, StrictInt, None] = Field( description="The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)." ) - x: Optional[StrictInt] = Field( - default=None, description="The horizontal offset in pixels for this form field." - ) - y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this form field." - ) - width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this form field." - ) - height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this form field." - ) - required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", - ) group: Optional[StrictStr] = Field( default=None, description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", - "signer", + "type", "x", "y", "width", "height", "required", + "signer", "group", ] @@ -192,15 +183,15 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { - "type": "(str,)", "api_id": "(str,)", "name": "(str,)", - "signer": "(int, str,)", + "type": "(str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "signer": "(int, str,)", "group": "(str,)", } 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 4edf644c2..620e742fe 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 @@ -41,15 +41,15 @@ class TemplateResponseDocumentCustomFieldCheckbox( description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", - "signer", + "type", "x", "y", "width", "height", "required", + "signer", "group", ] @@ -116,15 +116,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), - "signer": obj.get("signer"), + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), + "signer": obj.get("signer"), "group": obj.get("group"), } ) @@ -146,12 +146,12 @@ def openapi_types(cls) -> Dict[str, str]: "type": "(str,)", "api_id": "(str,)", "name": "(str,)", - "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "signer": "(int, str,)", "group": "(str,)", } 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 760dd57a4..79e87d225 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 @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictBool, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from dropbox_sign.models.template_response_document_custom_field_base import ( TemplateResponseDocumentCustomFieldBase, ) @@ -41,37 +41,32 @@ class TemplateResponseDocumentCustomFieldText(TemplateResponseDocumentCustomFiel type: StrictStr = Field( description="The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`" ) - avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None - is_multiline: Optional[StrictBool] = Field( - default=None, - description="Whether this form field is multiline text.", - alias="isMultiline", + avg_text_length: TemplateResponseFieldAvgTextLength + is_multiline: StrictBool = Field( + description="Whether this form field is multiline text.", alias="isMultiline" ) - original_font_size: Optional[StrictInt] = Field( - default=None, + original_font_size: StrictInt = Field( description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: Optional[StrictStr] = Field( - default=None, - description="Font family used in this form field's text.", - alias="fontFamily", + font_family: StrictStr = Field( + description="Font family used in this form field's text.", alias="fontFamily" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", - "signer", + "type", "x", "y", "width", "height", "required", - "group", "avg_text_length", "isMultiline", "originalFontSize", "fontFamily", + "signer", + "group", ] model_config = ConfigDict( @@ -140,16 +135,14 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), - "signer": obj.get("signer"), + "type": obj.get("type") if obj.get("type") is not None else "text", "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "group": obj.get("group"), "avg_text_length": ( TemplateResponseFieldAvgTextLength.from_dict(obj["avg_text_length"]) if obj.get("avg_text_length") is not None @@ -158,6 +151,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "isMultiline": obj.get("isMultiline"), "originalFontSize": obj.get("originalFontSize"), "fontFamily": obj.get("fontFamily"), + "signer": obj.get("signer"), + "group": obj.get("group"), } ) return _obj @@ -182,12 +177,12 @@ def openapi_types(cls) -> Dict[str, str]: "font_family": "(str,)", "api_id": "(str,)", "name": "(str,)", - "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "signer": "(int, str,)", "group": "(str,)", } 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 201bd139e..c74f1fe64 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 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from dropbox_sign.models.template_response_document_field_group_rule import ( TemplateResponseDocumentFieldGroupRule, ) @@ -35,10 +35,8 @@ class TemplateResponseDocumentFieldGroup(BaseModel): TemplateResponseDocumentFieldGroup """ # noqa: E501 - name: Optional[StrictStr] = Field( - default=None, description="The name of the form field group." - ) - rule: Optional[TemplateResponseDocumentFieldGroupRule] = None + name: StrictStr = Field(description="The name of the form field group.") + rule: TemplateResponseDocumentFieldGroupRule __properties: ClassVar[List[str]] = ["name", "rule"] model_config = ConfigDict( 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 e5ade9d4e..b932c4984 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 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -32,13 +32,10 @@ class TemplateResponseDocumentFieldGroupRule(BaseModel): The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). """ # noqa: E501 - requirement: Optional[StrictStr] = Field( - default=None, - description="Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.", - ) - group_label: Optional[StrictStr] = Field( - default=None, description="Name of the group", alias="groupLabel" + requirement: StrictStr = Field( + description="Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group." ) + group_label: StrictStr = Field(description="Name of the group", alias="groupLabel") __properties: ClassVar[List[str]] = ["requirement", "groupLabel"] model_config = ConfigDict( 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 a8052fd2a..2b5660900 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 @@ -20,7 +20,7 @@ from importlib import import_module from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Union from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -61,47 +61,33 @@ class TemplateResponseDocumentFormFieldBase(BaseModel): An array of Form Field objects containing the name and type of each named field. """ # noqa: E501 + api_id: StrictStr = Field(description="A unique id for the form field.") + name: StrictStr = Field(description="The name of the form field.") type: StrictStr - api_id: Optional[StrictStr] = Field( - default=None, description="A unique id for the form field." - ) - name: Optional[StrictStr] = Field( - default=None, description="The name of the form field." - ) signer: Union[StrictStr, StrictInt] = Field( description="The signer of the Form Field." ) - x: Optional[StrictInt] = Field( - default=None, description="The horizontal offset in pixels for this form field." - ) - y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this form field." - ) - width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this form field." - ) - height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this form field." + x: StrictInt = Field( + description="The horizontal offset in pixels for this form field." ) - required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", + y: StrictInt = Field( + description="The vertical offset in pixels for this form field." ) - group: Optional[StrictStr] = Field( - default=None, - description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + width: StrictInt = Field(description="The width in pixels of this form field.") + height: StrictInt = Field(description="The height in pixels of this form field.") + required: StrictBool = Field( + description="Boolean showing whether or not this field is required." ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", - "group", ] model_config = ConfigDict( @@ -252,16 +238,15 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { - "type": "(str,)", "api_id": "(str,)", "name": "(str,)", + "type": "(str,)", "signer": "(int, str,)", "x": "(int,)", "y": "(int,)", "width": "(int,)", "height": "(int,)", "required": "(bool,)", - "group": "(str,)", } @classmethod 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 9804d5077..807940bca 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 @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldCheckbox(TemplateResponseDocumentFormFiel type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), 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 14a9a2a08..0a58c895d 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 @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -40,10 +40,14 @@ class TemplateResponseDocumentFormFieldDateSigned( type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,11 +120,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "api_id": obj.get("api_id"), + "name": obj.get("name"), "type": ( obj.get("type") if obj.get("type") is not None else "date_signed" ), - "api_id": obj.get("api_id"), - "name": obj.get("name"), "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), 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 89351e112..6f99acde6 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 @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldDropdown(TemplateResponseDocumentFormFiel type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "dropdown", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "dropdown", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), 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 2c7529891..da496caa2 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 @@ -41,37 +41,36 @@ class TemplateResponseDocumentFormFieldHyperlink(TemplateResponseDocumentFormFie type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) - avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None - is_multiline: Optional[StrictBool] = Field( - default=None, - description="Whether this form field is multiline text.", - alias="isMultiline", + avg_text_length: TemplateResponseFieldAvgTextLength + is_multiline: StrictBool = Field( + description="Whether this form field is multiline text.", alias="isMultiline" ) - original_font_size: Optional[StrictInt] = Field( - default=None, + original_font_size: StrictInt = Field( description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: Optional[StrictStr] = Field( + font_family: StrictStr = Field( + description="Font family used in this form field's text.", alias="fontFamily" + ) + group: Optional[StrictStr] = Field( default=None, - description="Font family used in this form field's text.", - alias="fontFamily", + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", - "group", "avg_text_length", "isMultiline", "originalFontSize", "fontFamily", + "group", ] model_config = ConfigDict( @@ -140,16 +139,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "group": obj.get("group"), "avg_text_length": ( TemplateResponseFieldAvgTextLength.from_dict(obj["avg_text_length"]) if obj.get("avg_text_length") is not None @@ -158,6 +156,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "isMultiline": obj.get("isMultiline"), "originalFontSize": obj.get("originalFontSize"), "fontFamily": obj.get("fontFamily"), + "group": obj.get("group"), } ) return _obj 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 bded1e5f6..71b714532 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 @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldInitials(TemplateResponseDocumentFormFiel type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "initials", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "initials", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), 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 dd394e149..a38a7a65f 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 @@ -38,17 +38,20 @@ class TemplateResponseDocumentFormFieldRadio(TemplateResponseDocumentFormFieldBa type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: StrictStr = Field( + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields." + ) __properties: ClassVar[List[str]] = [ - "type", - "group", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", + "group", ] model_config = ConfigDict( @@ -114,16 +117,16 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "radio", - "group": obj.get("group"), "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "radio", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), + "group": obj.get("group"), } ) return _obj 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 fd82759b1..89ba48fcc 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 @@ -19,7 +19,7 @@ import json from pydantic import ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from dropbox_sign.models.template_response_document_form_field_base import ( TemplateResponseDocumentFormFieldBase, ) @@ -38,10 +38,14 @@ class TemplateResponseDocumentFormFieldSignature(TemplateResponseDocumentFormFie type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +118,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "signature", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "signature", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), 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 752e9a25b..8282093d9 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 @@ -48,42 +48,41 @@ class TemplateResponseDocumentFormFieldText(TemplateResponseDocumentFormFieldBas type: StrictStr = Field( description="The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials`" ) - avg_text_length: Optional[TemplateResponseFieldAvgTextLength] = None - is_multiline: Optional[StrictBool] = Field( - default=None, - description="Whether this form field is multiline text.", - alias="isMultiline", + avg_text_length: TemplateResponseFieldAvgTextLength + is_multiline: StrictBool = Field( + description="Whether this form field is multiline text.", alias="isMultiline" ) - original_font_size: Optional[StrictInt] = Field( - default=None, + original_font_size: StrictInt = Field( description="Original font size used in this form field's text.", alias="originalFontSize", ) - font_family: Optional[StrictStr] = Field( - default=None, - description="Font family used in this form field's text.", - alias="fontFamily", + font_family: StrictStr = Field( + description="Font family used in this form field's text.", alias="fontFamily" ) validation_type: Optional[StrictStr] = Field( default=None, description="Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.", ) + group: Optional[StrictStr] = Field( + default=None, + description="The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.", + ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", "width", "height", "required", - "group", "avg_text_length", "isMultiline", "originalFontSize", "fontFamily", "validation_type", + "group", ] @field_validator("validation_type") @@ -177,16 +176,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "text", "signer": obj.get("signer"), "x": obj.get("x"), "y": obj.get("y"), "width": obj.get("width"), "height": obj.get("height"), "required": obj.get("required"), - "group": obj.get("group"), "avg_text_length": ( TemplateResponseFieldAvgTextLength.from_dict(obj["avg_text_length"]) if obj.get("avg_text_length") is not None @@ -196,6 +194,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "originalFontSize": obj.get("originalFontSize"), "fontFamily": obj.get("fontFamily"), "validation_type": obj.get("validation_type"), + "group": obj.get("group"), } ) return _obj @@ -218,7 +217,6 @@ def openapi_types(cls) -> Dict[str, str]: "is_multiline": "(bool,)", "original_font_size": "(int,)", "font_family": "(str,)", - "validation_type": "(str,)", "api_id": "(str,)", "name": "(str,)", "signer": "(int, str,)", @@ -227,6 +225,7 @@ def openapi_types(cls) -> Dict[str, str]: "width": "(int,)", "height": "(int,)", "required": "(bool,)", + "validation_type": "(str,)", "group": "(str,)", } 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 4c16302d2..18d800e8f 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 @@ -61,41 +61,29 @@ class TemplateResponseDocumentStaticFieldBase(BaseModel): An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. """ # noqa: E501 + api_id: StrictStr = Field(description="A unique id for the static field.") + name: StrictStr = Field(description="The name of the static field.") type: StrictStr - api_id: Optional[StrictStr] = Field( - default=None, description="A unique id for the static field." + signer: StrictStr = Field(description="The signer of the Static Field.") + x: StrictInt = Field( + description="The horizontal offset in pixels for this static field." ) - name: Optional[StrictStr] = Field( - default=None, description="The name of the static field." + y: StrictInt = Field( + description="The vertical offset in pixels for this static field." ) - signer: Optional[StrictStr] = Field( - default="me_now", description="The signer of the Static Field." - ) - x: Optional[StrictInt] = Field( - default=None, - description="The horizontal offset in pixels for this static field.", - ) - y: Optional[StrictInt] = Field( - default=None, description="The vertical offset in pixels for this static field." - ) - width: Optional[StrictInt] = Field( - default=None, description="The width in pixels of this static field." - ) - height: Optional[StrictInt] = Field( - default=None, description="The height in pixels of this static field." - ) - required: Optional[StrictBool] = Field( - default=None, - description="Boolean showing whether or not this field is required.", + width: StrictInt = Field(description="The width in pixels of this static field.") + height: StrictInt = Field(description="The height in pixels of this static field.") + required: StrictBool = Field( + description="Boolean showing whether or not this field is required." ) group: Optional[StrictStr] = Field( default=None, description="The name of the group this field is in. If this field is not a group, this defaults to `null`.", ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -253,9 +241,9 @@ def from_dict(cls, obj: Dict[str, Any]) -> Optional[ @classmethod def openapi_types(cls) -> Dict[str, str]: return { - "type": "(str,)", "api_id": "(str,)", "name": "(str,)", + "type": "(str,)", "signer": "(str,)", "x": "(int,)", "y": "(int,)", 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 ea1c2b787..e56e41e37 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 @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldCheckbox( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "checkbox", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "checkbox", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 3a9bf86e0..e24b49d0d 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 @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldDateSigned( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,11 +116,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { + "api_id": obj.get("api_id"), + "name": obj.get("name"), "type": ( obj.get("type") if obj.get("type") is not None else "date_signed" ), - "api_id": obj.get("api_id"), - "name": obj.get("name"), "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 8444e77d8..7689e4f80 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 @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldDropdown( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "dropdown", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "dropdown", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 43106f1b1..8b5e4a5a9 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 @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldHyperlink( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "hyperlink", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 884425354..e6880abd5 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 @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldInitials( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "initials", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "initials", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 e0701f1cc..94873742e 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 @@ -39,9 +39,9 @@ class TemplateResponseDocumentStaticFieldRadio(TemplateResponseDocumentStaticFie description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +114,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "radio", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "radio", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 dbd12110f..417f92b19 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 @@ -41,9 +41,9 @@ class TemplateResponseDocumentStaticFieldSignature( description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -116,9 +116,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "signature", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "signature", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 7fe3d5925..deda059a0 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 @@ -39,9 +39,9 @@ class TemplateResponseDocumentStaticFieldText(TemplateResponseDocumentStaticFiel description="The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials`" ) __properties: ClassVar[List[str]] = [ - "type", "api_id", "name", + "type", "signer", "x", "y", @@ -114,9 +114,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate( { - "type": obj.get("type") if obj.get("type") is not None else "text", "api_id": obj.get("api_id"), "name": obj.get("name"), + "type": obj.get("type") if obj.get("type") is not None else "text", "signer": ( obj.get("signer") if obj.get("signer") is not None else "me_now" ), 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 b3b5d4aff..e2e27d72f 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 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictInt -from typing import Any, ClassVar, Dict, List, Optional +from typing import Any, ClassVar, Dict, List from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -32,10 +32,8 @@ class TemplateResponseFieldAvgTextLength(BaseModel): Average text length in this field. """ # noqa: E501 - num_lines: Optional[StrictInt] = Field(default=None, description="Number of lines.") - num_chars_per_line: Optional[StrictInt] = Field( - default=None, description="Number of characters per line." - ) + num_lines: StrictInt = Field(description="Number of lines.") + num_chars_per_line: StrictInt = Field(description="Number of characters per line.") __properties: ClassVar[List[str]] = ["num_lines", "num_chars_per_line"] model_config = ConfigDict( 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 aab8250c4..ffbf7a5b3 100644 --- a/sdks/python/dropbox_sign/models/template_response_signer_role.py +++ b/sdks/python/dropbox_sign/models/template_response_signer_role.py @@ -32,7 +32,7 @@ class TemplateResponseSignerRole(BaseModel): TemplateResponseSignerRole """ # noqa: E501 - name: Optional[StrictStr] = Field(default=None, description="The name of the Role.") + name: StrictStr = Field(description="The name of the Role.") order: Optional[StrictInt] = Field( default=None, description="If signer order is assigned this is the 0-based index for this role.", 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 a8fb50fa3..fc44b1dda 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 @@ -33,9 +33,7 @@ class TemplateUpdateFilesResponseTemplate(BaseModel): Contains template id """ # noqa: E501 - template_id: Optional[StrictStr] = Field( - default=None, description="The id of the Template." - ) + template_id: StrictStr = Field(description="The id of the Template.") warnings: Optional[List[WarningResponse]] = Field( default=None, description="A list of warnings." ) diff --git a/sdks/ruby/docs/OAuthTokenRefreshRequest.md b/sdks/ruby/docs/OAuthTokenRefreshRequest.md index 4bd1757c8..fe729fe82 100644 --- a/sdks/ruby/docs/OAuthTokenRefreshRequest.md +++ b/sdks/ruby/docs/OAuthTokenRefreshRequest.md @@ -8,6 +8,4 @@ | ---- | ---- | ----------- | ----- | | `grant_type`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```String``` | The token provided when you got the expired access token. | | -| `client_id` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | -| `client_secret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md index 9006aa0f8..d33b22d57 100644 --- a/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateEmbeddedDraftResponseTemplate.md @@ -6,8 +6,8 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | -| `edit_url` | ```String``` | Link to edit the template. | | -| `expires_at` | ```Integer``` | When the link expires. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | +| `edit_url`*_required_ | ```String``` | Link to edit the template. | | +| `expires_at`*_required_ | ```Integer``` | When the link expires. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | diff --git a/sdks/ruby/docs/TemplateCreateResponseTemplate.md b/sdks/ruby/docs/TemplateCreateResponseTemplate.md index 4d9488de7..4e63e9ea8 100644 --- a/sdks/ruby/docs/TemplateCreateResponseTemplate.md +++ b/sdks/ruby/docs/TemplateCreateResponseTemplate.md @@ -6,5 +6,5 @@ Template object with parameters: `template_id`. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | diff --git a/sdks/ruby/docs/TemplateResponse.md b/sdks/ruby/docs/TemplateResponse.md index 18c191b7b..4f3bc5e8a 100644 --- a/sdks/ruby/docs/TemplateResponse.md +++ b/sdks/ruby/docs/TemplateResponse.md @@ -6,19 +6,20 @@ Contains information about the templates you and your team have created. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | -| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | -| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | +| `title`*_required_ | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `message`*_required_ | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | | +| `is_creator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | +| `can_edit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | +| `is_locked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | +| `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | +| `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```Integer``` | Time the template was last updated. | | | `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `is_creator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | -| `can_edit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | -| `is_locked` | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | | `metadata` | ```Object``` | The metadata attached to the template. | | | `signer_roles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | | `cc_roles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | -| `documents` | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | -| `accounts` | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | diff --git a/sdks/ruby/docs/TemplateResponseAccount.md b/sdks/ruby/docs/TemplateResponseAccount.md index dcb2bc328..3c4b18f3c 100644 --- a/sdks/ruby/docs/TemplateResponseAccount.md +++ b/sdks/ruby/docs/TemplateResponseAccount.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `account_id` | ```String``` | The id of the Account. | | +| `account_id`*_required_ | ```String``` | The id of the Account. | | +| `is_locked`*_required_ | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | +| `is_paid_hs`*_required_ | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | +| `is_paid_hf`*_required_ | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | +| `quotas`*_required_ | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | | `email_address` | ```String``` | The email address associated with the Account. | | -| `is_locked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | | -| `is_paid_hs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | | -| `is_paid_hf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | | -| `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseAccountQuota.md b/sdks/ruby/docs/TemplateResponseAccountQuota.md index 8e314836a..1b67e4ee6 100644 --- a/sdks/ruby/docs/TemplateResponseAccountQuota.md +++ b/sdks/ruby/docs/TemplateResponseAccountQuota.md @@ -6,8 +6,8 @@ An array of the designated CC roles that must be specified when sending a Signat | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `templates_left` | ```Integer``` | API templates remaining. | | -| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | | -| `documents_left` | ```Integer``` | Signature requests remaining. | | -| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | | +| `templates_left`*_required_ | ```Integer``` | API templates remaining. | | +| `api_signature_requests_left`*_required_ | ```Integer``` | API signature requests remaining. | | +| `documents_left`*_required_ | ```Integer``` | Signature requests remaining. | | +| `sms_verifications_left`*_required_ | ```Integer``` | SMS verifications remaining. | | diff --git a/sdks/ruby/docs/TemplateResponseCCRole.md b/sdks/ruby/docs/TemplateResponseCCRole.md index b8c9b08f8..00ab61067 100644 --- a/sdks/ruby/docs/TemplateResponseCCRole.md +++ b/sdks/ruby/docs/TemplateResponseCCRole.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | diff --git a/sdks/ruby/docs/TemplateResponseDocument.md b/sdks/ruby/docs/TemplateResponseDocument.md index 5b9a105ae..6959cb0fa 100644 --- a/sdks/ruby/docs/TemplateResponseDocument.md +++ b/sdks/ruby/docs/TemplateResponseDocument.md @@ -6,10 +6,10 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | Name of the associated file. | | +| `name`*_required_ | ```String``` | Name of the associated file. | | +| `field_groups`*_required_ | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | +| `form_fields`*_required_ | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `custom_fields`*_required_ | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | +| `static_fields`*_required_ | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | | `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | | -| `field_groups` | [```Array```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | | -| `form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | | -| `static_fields` | [```Array```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md index 53f1fae78..01e988fcb 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldBase.md @@ -6,14 +6,14 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| `api_id`*_required_ | ```String``` | The unique ID for this field. | | +| `name`*_required_ | ```String``` | The name of the Custom Field. | | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | The unique ID for this field. | | -| `name` | ```String``` | The name of the Custom Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md index 52138173c..9582a0b11 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentCustomFieldText.md @@ -7,8 +7,8 @@ This class extends `TemplateResponseDocumentCustomFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.

* Text uses `TemplateResponseDocumentCustomFieldText`
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md index 114dba8b6..c8fea8928 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroup.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the form field group. | | -| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | +| `name`*_required_ | ```String``` | The name of the form field group. | | +| `rule`*_required_ | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md index 601ef69a3..ef8689712 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFieldGroupRule.md @@ -6,6 +6,6 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | -| `group_label` | ```String``` | Name of the group | | +| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`

- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | | +| `group_label`*_required_ | ```String``` | Name of the group | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md index 52620dc6d..0daaa439a 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldBase.md @@ -6,14 +6,13 @@ An array of Form Field objects containing the name and type of each named field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| `api_id`*_required_ | ```String``` | A unique id for the form field. | | +| `name`*_required_ | ```String``` | The name of the form field. | | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | A unique id for the form field. | | -| `name` | ```String``` | The name of the form field. | | -| `signer` | ```String``` | The signer of the Form Field. | | -| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this form field. | | -| `width` | ```Integer``` | The width in pixels of this form field. | | -| `height` | ```Integer``` | The height in pixels of this form field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | -| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | +| `signer`*_required_ | ```String``` | The signer of the Form Field. | | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this form field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this form field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this form field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this form field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md index 9eb4d6eed..13dd5cb48 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldCheckbox.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md index 3c1a4525b..253d8b41e 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDateSigned.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md index adf242b2f..b224d1011 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldDropdown.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md index 7c6059afb..83c3646b1 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldHyperlink.md @@ -7,8 +7,9 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md index de0250ace..63387d36e 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldInitials.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md index ef2728b81..fcdc459aa 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldRadio.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] | +| `group`*_required_ | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md index fd9e2b241..552a3c814 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldSignature.md @@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md index c35a1e3a1..15341ae02 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md +++ b/sdks/ruby/docs/TemplateResponseDocumentFormFieldText.md @@ -7,9 +7,10 @@ This class extends `TemplateResponseDocumentFormFieldBase` | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).

* Text Field uses `TemplateResponseDocumentFormFieldText`
* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`
* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`
* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`
* Radio Field uses `TemplateResponseDocumentFormFieldRadio`
* Signature Field uses `TemplateResponseDocumentFormFieldSignature`
* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`
* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] | -| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | -| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | | -| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | | -| `font_family` | ```String``` | Font family used in this form field's text. | | +| `avg_text_length`*_required_ | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | | +| `is_multiline`*_required_ | ```Boolean``` | Whether this form field is multiline text. | | +| `original_font_size`*_required_ | ```Integer``` | Original font size used in this form field's text. | | +| `font_family`*_required_ | ```String``` | Font family used in this form field's text. | | | `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | | +| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | | diff --git a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md index 49696a59f..b7b085348 100644 --- a/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md +++ b/sdks/ruby/docs/TemplateResponseDocumentStaticFieldBase.md @@ -6,14 +6,14 @@ An array describing static overlay fields. **NOTE:** Only available for certain | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | +| `api_id`*_required_ | ```String``` | A unique id for the static field. | | +| `name`*_required_ | ```String``` | The name of the static field. | | | `type`*_required_ | ```String``` | | | -| `api_id` | ```String``` | A unique id for the static field. | | -| `name` | ```String``` | The name of the static field. | | -| `signer` | ```String``` | The signer of the Static Field. | [default to 'me_now'] | -| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | | -| `y` | ```Integer``` | The vertical offset in pixels for this static field. | | -| `width` | ```Integer``` | The width in pixels of this static field. | | -| `height` | ```Integer``` | The height in pixels of this static field. | | -| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | | +| `signer`*_required_ | ```String``` | The signer of the Static Field. | [default to 'me_now'] | +| `x`*_required_ | ```Integer``` | The horizontal offset in pixels for this static field. | | +| `y`*_required_ | ```Integer``` | The vertical offset in pixels for this static field. | | +| `width`*_required_ | ```Integer``` | The width in pixels of this static field. | | +| `height`*_required_ | ```Integer``` | The height in pixels of this static field. | | +| `required`*_required_ | ```Boolean``` | Boolean showing whether or not this field is required. | | | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | | diff --git a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md index 923bc0fc1..ee8754dfc 100644 --- a/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md +++ b/sdks/ruby/docs/TemplateResponseFieldAvgTextLength.md @@ -6,6 +6,6 @@ Average text length in this field. | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `num_lines` | ```Integer``` | Number of lines. | | -| `num_chars_per_line` | ```Integer``` | Number of characters per line. | | +| `num_lines`*_required_ | ```Integer``` | Number of lines. | | +| `num_chars_per_line`*_required_ | ```Integer``` | Number of characters per line. | | diff --git a/sdks/ruby/docs/TemplateResponseSignerRole.md b/sdks/ruby/docs/TemplateResponseSignerRole.md index e61e1ef66..16d41a529 100644 --- a/sdks/ruby/docs/TemplateResponseSignerRole.md +++ b/sdks/ruby/docs/TemplateResponseSignerRole.md @@ -6,6 +6,6 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `name` | ```String``` | The name of the Role. | | +| `name`*_required_ | ```String``` | The name of the Role. | | | `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | | diff --git a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md index f0964f519..5f03f54e9 100644 --- a/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md +++ b/sdks/ruby/docs/TemplateUpdateFilesResponseTemplate.md @@ -6,6 +6,6 @@ Contains template id | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `template_id` | ```String``` | The id of the Template. | | +| `template_id`*_required_ | ```String``` | The id of the Template. | | | `warnings` | [```Array```](WarningResponse.md) | A list of warnings. | | 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 6e9d748e8..eb0c67745 100644 --- a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb @@ -108,20 +108,6 @@ def oauth_token_generate_with_http_info(o_auth_token_generate_request, opts = {} e.message end - 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 - body = @api_client.convert_to_type( - JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], - "Dropbox::Sign::ErrorResponse" - ) - - fail ApiError.new(:code => e.code, - :response_headers => e.response_headers, - :response_body => body), - e.message - end end @@ -217,20 +203,6 @@ def oauth_token_refresh_with_http_info(o_auth_token_refresh_request, opts = {}) e.message end - 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 - body = @api_client.convert_to_type( - JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], - "Dropbox::Sign::ErrorResponse" - ) - - fail ApiError.new(:code => e.code, - :response_headers => e.response_headers, - :response_body => body), - e.message - end end diff --git a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb index 3ac73212e..7628e0b2e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb @@ -26,21 +26,11 @@ class OAuthTokenRefreshRequest # @return [String] attr_accessor :refresh_token - # The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - # @return [String] - attr_accessor :client_id - - # The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. - # @return [String] - attr_accessor :client_secret - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'grant_type' => :'grant_type', - :'refresh_token' => :'refresh_token', - :'client_id' => :'client_id', - :'client_secret' => :'client_secret' + :'refresh_token' => :'refresh_token' } end @@ -53,9 +43,7 @@ def self.acceptable_attributes def self.openapi_types { :'grant_type' => :'String', - :'refresh_token' => :'String', - :'client_id' => :'String', - :'client_secret' => :'String' + :'refresh_token' => :'String' } end @@ -114,14 +102,6 @@ def initialize(attributes = {}) if attributes.key?(:'refresh_token') self.refresh_token = attributes[:'refresh_token'] end - - if attributes.key?(:'client_id') - self.client_id = attributes[:'client_id'] - end - - if attributes.key?(:'client_secret') - self.client_secret = attributes[:'client_secret'] - end end # Show invalid properties with the reasons. Usually used together with valid? @@ -153,9 +133,7 @@ def ==(o) return true if self.equal?(o) self.class == o.class && grant_type == o.grant_type && - refresh_token == o.refresh_token && - client_id == o.client_id && - client_secret == o.client_secret + refresh_token == o.refresh_token end # @see the `==` method @@ -167,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [grant_type, refresh_token, client_id, client_secret].hash + [grant_type, refresh_token].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb index a8eeafb20..7d005908e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb @@ -129,12 +129,27 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') + end + + if @edit_url.nil? + invalid_properties.push('invalid value for "edit_url", edit_url cannot be nil.') + end + + if @expires_at.nil? + invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @template_id.nil? + return false if @edit_url.nil? + return false if @expires_at.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb index 91e0dc57f..4abd9bbdc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_create_response_template.rb @@ -97,12 +97,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @template_id.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_response.rb index 7d14e8a13..8eb90d3b6 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response.rb @@ -31,26 +31,38 @@ class TemplateResponse # @return [String] attr_accessor :message - # Time the template was last updated. - # @return [Integer] - attr_accessor :updated_at - - # `true` if this template was created using an embedded flow, `false` if it was created on our website. - # @return [Boolean, nil] - attr_accessor :is_embedded - # `true` if you are the owner of this template, `false` if it's been shared with you by a team member. - # @return [Boolean, nil] + # @return [Boolean] attr_accessor :is_creator # Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). - # @return [Boolean, nil] + # @return [Boolean] attr_accessor :can_edit # Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. - # @return [Boolean, nil] + # @return [Boolean] attr_accessor :is_locked + # An array describing each document associated with this Template. Includes form field data for each document. + # @return [Array] + attr_accessor :documents + + # An array of the Accounts that can use this Template. + # @return [Array] + attr_accessor :accounts + + # Signer attachments. + # @return [Array] + attr_accessor :attachments + + # Time the template was last updated. + # @return [Integer] + attr_accessor :updated_at + + # `true` if this template was created using an embedded flow, `false` if it was created on our website. + # @return [Boolean, nil] + attr_accessor :is_embedded + # The metadata attached to the template. # @return [Object] attr_accessor :metadata @@ -63,10 +75,6 @@ class TemplateResponse # @return [Array] attr_accessor :cc_roles - # An array describing each document associated with this Template. Includes form field data for each document. - # @return [Array] - attr_accessor :documents - # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. # @return [Array, nil] attr_accessor :custom_fields @@ -75,28 +83,25 @@ class TemplateResponse # @return [Array, nil] attr_accessor :named_form_fields - # An array of the Accounts that can use this Template. - # @return [Array, nil] - attr_accessor :accounts - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'template_id' => :'template_id', :'title' => :'title', :'message' => :'message', - :'updated_at' => :'updated_at', - :'is_embedded' => :'is_embedded', :'is_creator' => :'is_creator', :'can_edit' => :'can_edit', :'is_locked' => :'is_locked', + :'documents' => :'documents', + :'accounts' => :'accounts', + :'attachments' => :'attachments', + :'updated_at' => :'updated_at', + :'is_embedded' => :'is_embedded', :'metadata' => :'metadata', :'signer_roles' => :'signer_roles', :'cc_roles' => :'cc_roles', - :'documents' => :'documents', :'custom_fields' => :'custom_fields', - :'named_form_fields' => :'named_form_fields', - :'accounts' => :'accounts' + :'named_form_fields' => :'named_form_fields' } end @@ -111,18 +116,19 @@ def self.openapi_types :'template_id' => :'String', :'title' => :'String', :'message' => :'String', - :'updated_at' => :'Integer', - :'is_embedded' => :'Boolean', :'is_creator' => :'Boolean', :'can_edit' => :'Boolean', :'is_locked' => :'Boolean', + :'documents' => :'Array', + :'accounts' => :'Array', + :'attachments' => :'Array', + :'updated_at' => :'Integer', + :'is_embedded' => :'Boolean', :'metadata' => :'Object', :'signer_roles' => :'Array', :'cc_roles' => :'Array', - :'documents' => :'Array', :'custom_fields' => :'Array', - :'named_form_fields' => :'Array', - :'accounts' => :'Array' + :'named_form_fields' => :'Array' } end @@ -130,12 +136,8 @@ def self.openapi_types def self.openapi_nullable Set.new([ :'is_embedded', - :'is_creator', - :'can_edit', - :'is_locked', :'custom_fields', - :'named_form_fields', - :'accounts' + :'named_form_fields' ]) end @@ -191,14 +193,6 @@ def initialize(attributes = {}) self.message = attributes[:'message'] end - if attributes.key?(:'updated_at') - self.updated_at = attributes[:'updated_at'] - end - - if attributes.key?(:'is_embedded') - self.is_embedded = attributes[:'is_embedded'] - end - if attributes.key?(:'is_creator') self.is_creator = attributes[:'is_creator'] end @@ -211,6 +205,32 @@ def initialize(attributes = {}) self.is_locked = attributes[:'is_locked'] end + if attributes.key?(:'documents') + if (value = attributes[:'documents']).is_a?(Array) + self.documents = value + end + end + + if attributes.key?(:'accounts') + if (value = attributes[:'accounts']).is_a?(Array) + self.accounts = value + end + end + + if attributes.key?(:'attachments') + if (value = attributes[:'attachments']).is_a?(Array) + self.attachments = value + end + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + end + + if attributes.key?(:'is_embedded') + self.is_embedded = attributes[:'is_embedded'] + end + if attributes.key?(:'metadata') self.metadata = attributes[:'metadata'] end @@ -227,12 +247,6 @@ def initialize(attributes = {}) end end - if attributes.key?(:'documents') - if (value = attributes[:'documents']).is_a?(Array) - self.documents = value - end - end - if attributes.key?(:'custom_fields') if (value = attributes[:'custom_fields']).is_a?(Array) self.custom_fields = value @@ -244,24 +258,63 @@ def initialize(attributes = {}) self.named_form_fields = value end end - - if attributes.key?(:'accounts') - if (value = attributes[:'accounts']).is_a?(Array) - self.accounts = value - end - end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') + end + + if @title.nil? + invalid_properties.push('invalid value for "title", title cannot be nil.') + end + + if @message.nil? + invalid_properties.push('invalid value for "message", message cannot be nil.') + end + + if @is_creator.nil? + invalid_properties.push('invalid value for "is_creator", is_creator cannot be nil.') + end + + if @can_edit.nil? + invalid_properties.push('invalid value for "can_edit", can_edit cannot be nil.') + end + + if @is_locked.nil? + invalid_properties.push('invalid value for "is_locked", is_locked cannot be nil.') + end + + if @documents.nil? + invalid_properties.push('invalid value for "documents", documents cannot be nil.') + end + + if @accounts.nil? + invalid_properties.push('invalid value for "accounts", accounts cannot be nil.') + end + + if @attachments.nil? + invalid_properties.push('invalid value for "attachments", attachments cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @template_id.nil? + return false if @title.nil? + return false if @message.nil? + return false if @is_creator.nil? + return false if @can_edit.nil? + return false if @is_locked.nil? + return false if @documents.nil? + return false if @accounts.nil? + return false if @attachments.nil? true end @@ -273,18 +326,19 @@ def ==(o) template_id == o.template_id && title == o.title && message == o.message && - updated_at == o.updated_at && - is_embedded == o.is_embedded && is_creator == o.is_creator && can_edit == o.can_edit && is_locked == o.is_locked && + documents == o.documents && + accounts == o.accounts && + attachments == o.attachments && + updated_at == o.updated_at && + is_embedded == o.is_embedded && metadata == o.metadata && signer_roles == o.signer_roles && cc_roles == o.cc_roles && - documents == o.documents && custom_fields == o.custom_fields && - named_form_fields == o.named_form_fields && - accounts == o.accounts + named_form_fields == o.named_form_fields end # @see the `==` method @@ -296,7 +350,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_id, title, message, updated_at, is_embedded, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, custom_fields, named_form_fields, accounts].hash + [template_id, title, message, is_creator, can_edit, is_locked, documents, accounts, attachments, updated_at, is_embedded, metadata, signer_roles, cc_roles, custom_fields, named_form_fields].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb index c40120392..81a10b28d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account.rb @@ -22,10 +22,6 @@ class TemplateResponseAccount # @return [String] attr_accessor :account_id - # The email address associated with the Account. - # @return [String] - attr_accessor :email_address - # Returns `true` if the user has been locked out of their account by a team admin. # @return [Boolean] attr_accessor :is_locked @@ -41,15 +37,19 @@ class TemplateResponseAccount # @return [TemplateResponseAccountQuota] attr_accessor :quotas + # The email address associated with the Account. + # @return [String] + attr_accessor :email_address + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'account_id' => :'account_id', - :'email_address' => :'email_address', :'is_locked' => :'is_locked', :'is_paid_hs' => :'is_paid_hs', :'is_paid_hf' => :'is_paid_hf', - :'quotas' => :'quotas' + :'quotas' => :'quotas', + :'email_address' => :'email_address' } end @@ -62,11 +62,11 @@ def self.acceptable_attributes def self.openapi_types { :'account_id' => :'String', - :'email_address' => :'String', :'is_locked' => :'Boolean', :'is_paid_hs' => :'Boolean', :'is_paid_hf' => :'Boolean', - :'quotas' => :'TemplateResponseAccountQuota' + :'quotas' => :'TemplateResponseAccountQuota', + :'email_address' => :'String' } end @@ -120,10 +120,6 @@ def initialize(attributes = {}) self.account_id = attributes[:'account_id'] end - if attributes.key?(:'email_address') - self.email_address = attributes[:'email_address'] - end - if attributes.key?(:'is_locked') self.is_locked = attributes[:'is_locked'] end @@ -139,18 +135,47 @@ def initialize(attributes = {}) if attributes.key?(:'quotas') self.quotas = attributes[:'quotas'] end + + if attributes.key?(:'email_address') + self.email_address = attributes[:'email_address'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @account_id.nil? + invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') + end + + if @is_locked.nil? + invalid_properties.push('invalid value for "is_locked", is_locked cannot be nil.') + end + + if @is_paid_hs.nil? + invalid_properties.push('invalid value for "is_paid_hs", is_paid_hs cannot be nil.') + end + + if @is_paid_hf.nil? + invalid_properties.push('invalid value for "is_paid_hf", is_paid_hf cannot be nil.') + end + + if @quotas.nil? + invalid_properties.push('invalid value for "quotas", quotas cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @account_id.nil? + return false if @is_locked.nil? + return false if @is_paid_hs.nil? + return false if @is_paid_hf.nil? + return false if @quotas.nil? true end @@ -160,11 +185,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && account_id == o.account_id && - email_address == o.email_address && is_locked == o.is_locked && is_paid_hs == o.is_paid_hs && is_paid_hf == o.is_paid_hf && - quotas == o.quotas + quotas == o.quotas && + email_address == o.email_address end # @see the `==` method @@ -176,7 +201,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas].hash + [account_id, is_locked, is_paid_hs, is_paid_hf, quotas, email_address].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb index 4e46afa40..5ae884798 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_account_quota.rb @@ -127,12 +127,32 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @templates_left.nil? + invalid_properties.push('invalid value for "templates_left", templates_left cannot be nil.') + end + + if @api_signature_requests_left.nil? + invalid_properties.push('invalid value for "api_signature_requests_left", api_signature_requests_left cannot be nil.') + end + + if @documents_left.nil? + invalid_properties.push('invalid value for "documents_left", documents_left cannot be nil.') + end + + if @sms_verifications_left.nil? + invalid_properties.push('invalid value for "sms_verifications_left", sms_verifications_left cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @templates_left.nil? + return false if @api_signature_requests_left.nil? + return false if @documents_left.nil? + return false if @sms_verifications_left.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb index 7b73e8d36..6b62d9366 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_cc_role.rb @@ -96,12 +96,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @name.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb index 6d23cb39f..c1103ef2b 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document.rb @@ -22,10 +22,6 @@ class TemplateResponseDocument # @return [String] attr_accessor :name - # Document ordering, the lowest index is displayed first and the highest last (0-based indexing). - # @return [Integer] - attr_accessor :index - # An array of Form Field Group objects. # @return [Array] attr_accessor :field_groups @@ -39,18 +35,22 @@ class TemplateResponseDocument attr_accessor :custom_fields # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. - # @return [Array, nil] + # @return [Array] attr_accessor :static_fields + # Document ordering, the lowest index is displayed first and the highest last (0-based indexing). + # @return [Integer] + attr_accessor :index + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'name' => :'name', - :'index' => :'index', :'field_groups' => :'field_groups', :'form_fields' => :'form_fields', :'custom_fields' => :'custom_fields', - :'static_fields' => :'static_fields' + :'static_fields' => :'static_fields', + :'index' => :'index' } end @@ -63,18 +63,17 @@ def self.acceptable_attributes def self.openapi_types { :'name' => :'String', - :'index' => :'Integer', :'field_groups' => :'Array', :'form_fields' => :'Array', :'custom_fields' => :'Array', - :'static_fields' => :'Array' + :'static_fields' => :'Array', + :'index' => :'Integer' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'static_fields' ]) end @@ -122,10 +121,6 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end - if attributes.key?(:'index') - self.index = attributes[:'index'] - end - if attributes.key?(:'field_groups') if (value = attributes[:'field_groups']).is_a?(Array) self.field_groups = value @@ -149,18 +144,47 @@ def initialize(attributes = {}) self.static_fields = value end end + + if attributes.key?(:'index') + self.index = attributes[:'index'] + end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @field_groups.nil? + invalid_properties.push('invalid value for "field_groups", field_groups cannot be nil.') + end + + if @form_fields.nil? + invalid_properties.push('invalid value for "form_fields", form_fields cannot be nil.') + end + + if @custom_fields.nil? + invalid_properties.push('invalid value for "custom_fields", custom_fields cannot be nil.') + end + + if @static_fields.nil? + invalid_properties.push('invalid value for "static_fields", static_fields cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @name.nil? + return false if @field_groups.nil? + return false if @form_fields.nil? + return false if @custom_fields.nil? + return false if @static_fields.nil? true end @@ -170,11 +194,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && - index == o.index && field_groups == o.field_groups && form_fields == o.form_fields && custom_fields == o.custom_fields && - static_fields == o.static_fields + static_fields == o.static_fields && + index == o.index end # @see the `==` method @@ -186,7 +210,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [name, index, field_groups, form_fields, custom_fields, static_fields].hash + [name, field_groups, form_fields, custom_fields, static_fields, index].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb index a80739b91..76ae0662a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_base.rb @@ -19,9 +19,6 @@ module Dropbox module Dropbox::Sign # An array of Form Field objects containing the name and type of each named field. class TemplateResponseDocumentCustomFieldBase - # @return [String] - attr_accessor :type - # The unique ID for this field. # @return [String] attr_accessor :api_id @@ -30,9 +27,8 @@ class TemplateResponseDocumentCustomFieldBase # @return [String] attr_accessor :name - # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). - # @return [Integer, String, nil] - attr_accessor :signer + # @return [String] + attr_accessor :type # The horizontal offset in pixels for this form field. # @return [Integer] @@ -54,6 +50,10 @@ class TemplateResponseDocumentCustomFieldBase # @return [Boolean] attr_accessor :required + # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). + # @return [Integer, String, nil] + attr_accessor :signer + # The name of the group this field is in. If this field is not a group, this defaults to `null`. # @return [String, nil] attr_accessor :group @@ -61,15 +61,15 @@ class TemplateResponseDocumentCustomFieldBase # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', - :'signer' => :'signer', + :'type' => :'type', :'x' => :'x', :'y' => :'y', :'width' => :'width', :'height' => :'height', :'required' => :'required', + :'signer' => :'signer', :'group' => :'group' } end @@ -82,15 +82,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String', :'api_id' => :'String', :'name' => :'String', - :'signer' => :'String', + :'type' => :'String', :'x' => :'Integer', :'y' => :'Integer', :'width' => :'Integer', :'height' => :'Integer', :'required' => :'Boolean', + :'signer' => :'String', :'group' => :'String' } end @@ -151,10 +151,6 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -163,8 +159,8 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end - if attributes.key?(:'signer') - self.signer = attributes[:'signer'] + if attributes.key?(:'type') + self.type = attributes[:'type'] end if attributes.key?(:'x') @@ -187,6 +183,10 @@ def initialize(attributes = {}) self.required = attributes[:'required'] end + if attributes.key?(:'signer') + self.signer = attributes[:'signer'] + end + if attributes.key?(:'group') self.group = attributes[:'group'] end @@ -196,17 +196,52 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @api_id.nil? + invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') + end + + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @x.nil? + invalid_properties.push('invalid value for "x", x cannot be nil.') + end + + if @y.nil? + invalid_properties.push('invalid value for "y", y cannot be nil.') + end + + if @width.nil? + invalid_properties.push('invalid value for "width", width cannot be nil.') + end + + if @height.nil? + invalid_properties.push('invalid value for "height", height cannot be nil.') + end + + if @required.nil? + invalid_properties.push('invalid value for "required", required cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @api_id.nil? + return false if @name.nil? return false if @type.nil? + return false if @x.nil? + return false if @y.nil? + return false if @width.nil? + return false if @height.nil? + return false if @required.nil? true end @@ -215,15 +250,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && api_id == o.api_id && name == o.name && - signer == o.signer && + type == o.type && x == o.x && y == o.y && width == o.width && height == o.height && required == o.required && + signer == o.signer && group == o.group end @@ -236,7 +271,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, api_id, name, signer, x, y, width, height, required, group].hash + [api_id, name, type, x, y, width, height, required, signer, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb index 653b131ae..6205bf088 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_custom_field_text.rb @@ -145,6 +145,22 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @avg_text_length.nil? + invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') + end + + if @is_multiline.nil? + invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') + end + + if @original_font_size.nil? + invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') + end + + if @font_family.nil? + invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') + end + invalid_properties end @@ -152,6 +168,10 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @avg_text_length.nil? + return false if @is_multiline.nil? + return false if @original_font_size.nil? + return false if @font_family.nil? true && super end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb index ce2389e3a..0352a4080 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group.rb @@ -105,12 +105,22 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + + if @rule.nil? + invalid_properties.push('invalid value for "rule", rule cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @name.nil? + return false if @rule.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb index 5b0d3ec6d..27ba34343 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_field_group_rule.rb @@ -107,12 +107,22 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @requirement.nil? + invalid_properties.push('invalid value for "requirement", requirement cannot be nil.') + end + + if @group_label.nil? + invalid_properties.push('invalid value for "group_label", group_label cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @requirement.nil? + return false if @group_label.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb index f9917555b..c7aa4af27 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_base.rb @@ -19,9 +19,6 @@ module Dropbox module Dropbox::Sign # An array of Form Field objects containing the name and type of each named field. class TemplateResponseDocumentFormFieldBase - # @return [String] - attr_accessor :type - # A unique id for the form field. # @return [String] attr_accessor :api_id @@ -30,6 +27,9 @@ class TemplateResponseDocumentFormFieldBase # @return [String] attr_accessor :name + # @return [String] + attr_accessor :type + # The signer of the Form Field. # @return [Integer, String] attr_accessor :signer @@ -54,23 +54,18 @@ class TemplateResponseDocumentFormFieldBase # @return [Boolean] attr_accessor :required - # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. - # @return [String, nil] - attr_accessor :group - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', + :'type' => :'type', :'signer' => :'signer', :'x' => :'x', :'y' => :'y', :'width' => :'width', :'height' => :'height', - :'required' => :'required', - :'group' => :'group' + :'required' => :'required' } end @@ -82,23 +77,21 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String', :'api_id' => :'String', :'name' => :'String', + :'type' => :'String', :'signer' => :'String', :'x' => :'Integer', :'y' => :'Integer', :'width' => :'Integer', :'height' => :'Integer', - :'required' => :'Boolean', - :'group' => :'String' + :'required' => :'Boolean' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'group' ]) end @@ -168,10 +161,6 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -180,6 +169,10 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'signer') self.signer = attributes[:'signer'] end @@ -203,27 +196,63 @@ def initialize(attributes = {}) if attributes.key?(:'required') self.required = attributes[:'required'] end - - if attributes.key?(:'group') - self.group = attributes[:'group'] - end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @api_id.nil? + invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') + end + + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @signer.nil? + invalid_properties.push('invalid value for "signer", signer cannot be nil.') + end + + if @x.nil? + invalid_properties.push('invalid value for "x", x cannot be nil.') + end + + if @y.nil? + invalid_properties.push('invalid value for "y", y cannot be nil.') + end + + if @width.nil? + invalid_properties.push('invalid value for "width", width cannot be nil.') + end + + if @height.nil? + invalid_properties.push('invalid value for "height", height cannot be nil.') + end + + if @required.nil? + invalid_properties.push('invalid value for "required", required cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @api_id.nil? + return false if @name.nil? return false if @type.nil? + return false if @signer.nil? + return false if @x.nil? + return false if @y.nil? + return false if @width.nil? + return false if @height.nil? + return false if @required.nil? true end @@ -232,16 +261,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && api_id == o.api_id && name == o.name && + type == o.type && signer == o.signer && x == o.x && y == o.y && width == o.width && height == o.height && - required == o.required && - group == o.group + required == o.required end # @see the `==` method @@ -253,7 +281,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, api_id, name, signer, x, y, width, height, required, group].hash + [api_id, name, type, signer, x, y, width, height, required].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb index c888138c3..a4c759c12 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldCheckbox < TemplateResponseDocumentFormFi # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'checkbox' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb index 94ec5f659..f20f04c4f 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldDateSigned < TemplateResponseDocumentForm # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'date_signed' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb index 0291303b4..c6ad1b3dd 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldDropdown < TemplateResponseDocumentFormFi # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'dropdown' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb index 7c8992ffa..8ae570661 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb @@ -38,6 +38,10 @@ class TemplateResponseDocumentFormFieldHyperlink < TemplateResponseDocumentFormF # @return [String] attr_accessor :font_family + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -45,7 +49,8 @@ def self.attribute_map :'avg_text_length' => :'avg_text_length', :'is_multiline' => :'isMultiline', :'original_font_size' => :'originalFontSize', - :'font_family' => :'fontFamily' + :'font_family' => :'fontFamily', + :'group' => :'group' } end @@ -61,13 +66,15 @@ def self.openapi_types :'avg_text_length' => :'TemplateResponseFieldAvgTextLength', :'is_multiline' => :'Boolean', :'original_font_size' => :'Integer', - :'font_family' => :'String' + :'font_family' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -135,6 +142,10 @@ def initialize(attributes = {}) if attributes.key?(:'font_family') self.font_family = attributes[:'font_family'] end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -145,6 +156,22 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @avg_text_length.nil? + invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') + end + + if @is_multiline.nil? + invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') + end + + if @original_font_size.nil? + invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') + end + + if @font_family.nil? + invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') + end + invalid_properties end @@ -152,6 +179,10 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @avg_text_length.nil? + return false if @is_multiline.nil? + return false if @original_font_size.nil? + return false if @font_family.nil? true && super end @@ -164,7 +195,8 @@ def ==(o) avg_text_length == o.avg_text_length && is_multiline == o.is_multiline && original_font_size == o.original_font_size && - font_family == o.font_family && super(o) + font_family == o.font_family && + group == o.group && super(o) end # @see the `==` method @@ -176,7 +208,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, avg_text_length, is_multiline, original_font_size, font_family].hash + [type, avg_text_length, is_multiline, original_font_size, font_family, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb index 70f5ed581..3ff48a726 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_initials.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldInitials < TemplateResponseDocumentFormFi # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'initials' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb index 2412dc9dc..6af0b07d8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_radio.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldRadio < TemplateResponseDocumentFormField # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,7 +43,8 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end @@ -96,6 +102,10 @@ def initialize(attributes = {}) else self.type = 'radio' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -106,6 +116,10 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @group.nil? + invalid_properties.push('invalid value for "group", group cannot be nil.') + end + invalid_properties end @@ -113,6 +127,7 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @group.nil? true && super end @@ -121,7 +136,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +149,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb index 49fdbbbc4..c48d15719 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_signature.rb @@ -23,10 +23,15 @@ class TemplateResponseDocumentFormFieldSignature < TemplateResponseDocumentFormF # @return [String] attr_accessor :type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type' + :'type' => :'type', + :'group' => :'group' } end @@ -38,13 +43,15 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String' + :'type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'group' ]) end @@ -96,6 +103,10 @@ def initialize(attributes = {}) else self.type = 'signature' end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -121,7 +132,8 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && super(o) + type == o.type && + group == o.group && super(o) end # @see the `==` method @@ -133,7 +145,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type].hash + [type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb index 6a11d8a29..b5b10d59d 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_form_field_text.rb @@ -42,6 +42,10 @@ class TemplateResponseDocumentFormFieldText < TemplateResponseDocumentFormFieldB # @return [String, nil] attr_accessor :validation_type + # The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. + # @return [String, nil] + attr_accessor :group + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -72,7 +76,8 @@ def self.attribute_map :'is_multiline' => :'isMultiline', :'original_font_size' => :'originalFontSize', :'font_family' => :'fontFamily', - :'validation_type' => :'validation_type' + :'validation_type' => :'validation_type', + :'group' => :'group' } end @@ -89,14 +94,16 @@ def self.openapi_types :'is_multiline' => :'Boolean', :'original_font_size' => :'Integer', :'font_family' => :'String', - :'validation_type' => :'String' + :'validation_type' => :'String', + :'group' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ - :'validation_type' + :'validation_type', + :'group' ]) end @@ -168,6 +175,10 @@ def initialize(attributes = {}) if attributes.key?(:'validation_type') self.validation_type = attributes[:'validation_type'] end + + if attributes.key?(:'group') + self.group = attributes[:'group'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -178,6 +189,22 @@ def list_invalid_properties invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @avg_text_length.nil? + invalid_properties.push('invalid value for "avg_text_length", avg_text_length cannot be nil.') + end + + if @is_multiline.nil? + invalid_properties.push('invalid value for "is_multiline", is_multiline cannot be nil.') + end + + if @original_font_size.nil? + invalid_properties.push('invalid value for "original_font_size", original_font_size cannot be nil.') + end + + if @font_family.nil? + invalid_properties.push('invalid value for "font_family", font_family cannot be nil.') + end + invalid_properties end @@ -185,6 +212,10 @@ def list_invalid_properties # @return true if the model is valid def valid? return false if @type.nil? + return false if @avg_text_length.nil? + return false if @is_multiline.nil? + return false if @original_font_size.nil? + return false if @font_family.nil? validation_type_validator = EnumAttributeValidator.new('String', ["numbers_only", "letters_only", "phone_number", "bank_routing_number", "bank_account_number", "email_address", "zip_code", "social_security_number", "employer_identification_number", "custom_regex"]) return false unless validation_type_validator.valid?(@validation_type) true && super @@ -210,7 +241,8 @@ def ==(o) is_multiline == o.is_multiline && original_font_size == o.original_font_size && font_family == o.font_family && - validation_type == o.validation_type && super(o) + validation_type == o.validation_type && + group == o.group && super(o) end # @see the `==` method @@ -222,7 +254,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, avg_text_length, is_multiline, original_font_size, font_family, validation_type].hash + [type, avg_text_length, is_multiline, original_font_size, font_family, validation_type, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb index a2d962291..8a4cbac11 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_document_static_field_base.rb @@ -19,9 +19,6 @@ module Dropbox module Dropbox::Sign # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. class TemplateResponseDocumentStaticFieldBase - # @return [String] - attr_accessor :type - # A unique id for the static field. # @return [String] attr_accessor :api_id @@ -30,6 +27,9 @@ class TemplateResponseDocumentStaticFieldBase # @return [String] attr_accessor :name + # @return [String] + attr_accessor :type + # The signer of the Static Field. # @return [String] attr_accessor :signer @@ -61,9 +61,9 @@ class TemplateResponseDocumentStaticFieldBase # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { - :'type' => :'type', :'api_id' => :'api_id', :'name' => :'name', + :'type' => :'type', :'signer' => :'signer', :'x' => :'x', :'y' => :'y', @@ -82,9 +82,9 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'type' => :'String', :'api_id' => :'String', :'name' => :'String', + :'type' => :'String', :'signer' => :'String', :'x' => :'Integer', :'y' => :'Integer', @@ -168,10 +168,6 @@ def initialize(attributes = {}) h[k.to_sym] = v } - if attributes.key?(:'type') - self.type = attributes[:'type'] - end - if attributes.key?(:'api_id') self.api_id = attributes[:'api_id'] end @@ -180,6 +176,10 @@ def initialize(attributes = {}) self.name = attributes[:'name'] end + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + if attributes.key?(:'signer') self.signer = attributes[:'signer'] else @@ -215,17 +215,57 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @api_id.nil? + invalid_properties.push('invalid value for "api_id", api_id cannot be nil.') + end + + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end + if @signer.nil? + invalid_properties.push('invalid value for "signer", signer cannot be nil.') + end + + if @x.nil? + invalid_properties.push('invalid value for "x", x cannot be nil.') + end + + if @y.nil? + invalid_properties.push('invalid value for "y", y cannot be nil.') + end + + if @width.nil? + invalid_properties.push('invalid value for "width", width cannot be nil.') + end + + if @height.nil? + invalid_properties.push('invalid value for "height", height cannot be nil.') + end + + if @required.nil? + invalid_properties.push('invalid value for "required", required cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @api_id.nil? + return false if @name.nil? return false if @type.nil? + return false if @signer.nil? + return false if @x.nil? + return false if @y.nil? + return false if @width.nil? + return false if @height.nil? + return false if @required.nil? true end @@ -234,9 +274,9 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && - type == o.type && api_id == o.api_id && name == o.name && + type == o.type && signer == o.signer && x == o.x && y == o.y && @@ -255,7 +295,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [type, api_id, name, signer, x, y, width, height, required, group].hash + [api_id, name, type, signer, x, y, width, height, required, group].hash end # Builds the object from hash diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb index a85e2c339..172098f29 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_field_avg_text_length.rb @@ -107,12 +107,22 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @num_lines.nil? + invalid_properties.push('invalid value for "num_lines", num_lines cannot be nil.') + end + + if @num_chars_per_line.nil? + invalid_properties.push('invalid value for "num_chars_per_line", num_chars_per_line cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @num_lines.nil? + return false if @num_chars_per_line.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb index 286607280..ea43ce2bc 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response_signer_role.rb @@ -106,12 +106,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @name.nil? + invalid_properties.push('invalid value for "name", name cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @name.nil? true end diff --git a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb index 97280f302..23748015e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_update_files_response_template.rb @@ -109,12 +109,17 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new + if @template_id.nil? + invalid_properties.push('invalid value for "template_id", template_id cannot be nil.') + end + invalid_properties end # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? + return false if @template_id.nil? true end diff --git a/test_fixtures/TemplateGetResponse.json b/test_fixtures/TemplateGetResponse.json index 52ff62260..b025913a0 100644 --- a/test_fixtures/TemplateGetResponse.json +++ b/test_fixtures/TemplateGetResponse.json @@ -5,7 +5,10 @@ "title": "Mutual NDA", "message": "Please sign this NDA as soon as possible.", "updated_at": 1570471067, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -566,496 +569,40 @@ ] } ], - "custom_fields": [ - { - "name": "merge_field_1", - "type": "text", - "x": 417, - "y": 219, - "width": 72, - "height": 15, - "required": false, - "api_id": "967c3e5f-2912-4f53-8ea3-c750652d29fc", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "merge_field_2", - "type": "checkbox", - "x": 515, - "y": 346, - "width": 18, - "height": 18, - "required": false, - "api_id": "5e8fe02f-51cf-4f0b-b1d9-2b1e4f6ad07f" - } - ], - "named_form_fields": [ - { - "name": "Signature1", - "type": "signature", - "signer": "1", - "x": 136, - "y": 17, - "width": 108, - "height": 27, - "required": true, - "api_id": "8b6d78a5-0870-4f46-af9c-b78b54a49348" - }, - { - "name": "Textbox1", - "type": "text", - "signer": "1", - "x": 328, - "y": 17, - "width": 144, - "height": 14, - "required": true, - "api_id": "7ec10d80-53c9-433b-b252-0b8daa90a8e0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox2", - "type": "text", - "signer": "1", - "x": 328, - "y": 48, - "width": 144, - "height": 14, - "required": true, - "api_id": "6574e6ad-7dac-49a2-9d56-650d7c5ade6e", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Initial1", - "type": "initials", - "signer": "1", - "x": 148, - "y": 66, - "width": 72, - "height": 27, - "required": true, - "api_id": "30f41f54-c7f3-46c3-a29a-bb76ec40b552" - }, - { - "name": "Checkbox1", - "type": "checkbox", - "signer": "1", - "x": 325, - "y": 111, - "width": 18, - "height": 18, - "required": false, - "api_id": "d4d6ada9-e1dc-419e-bc0d-1478da694449", - "group": "75a6e4b5fea47" - }, - { - "name": "Dropdown1", - "type": "dropdown", - "signer": "1", - "x": 423, - "y": 108, - "width": 70, - "height": 14, - "required": true, - "api_id": "5863be5e-ce5a-4c9d-aabe-c221914d73c2" - }, - { - "name": "DateSigned1", - "type": "date_signed", - "signer": "1", - "x": 150, - "y": 119, - "width": 105, - "height": 18, - "required": true, - "api_id": "9f6d3722-6db7-46da-8fac-3bc09f510262" - }, - { - "name": "Checkbox2", - "type": "checkbox", - "signer": "1", - "x": 325, - "y": 135, - "width": 18, - "height": 18, - "required": false, - "api_id": "edd732b8-b158-4714-a87b-503637d09ded", - "group": "75a6e4b5fea47" - }, - { - "name": "FullName1", - "type": "text", - "signer": "1", - "x": 144, - "y": 158, - "width": 72, - "height": 14, - "required": true, - "api_id": "62fd3f85-4808-4011-8eae-a14ebe9105ef", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Email1", - "type": "text", - "signer": "1", - "x": 133, - "y": 191, - "width": 144, - "height": 14, - "required": true, - "api_id": "a1c9bc6b-d498-4787-86e0-30ea779f06a7", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "email_address" - }, - { - "name": "RadioItem1", - "type": "radio", - "signer": "1", - "x": 307, - "y": 211, - "width": 18, - "height": 18, - "required": false, - "api_id": "fc8a1277-f757-47a2-aeea-5113fa81f2d5", - "group": "0831822584086" - }, - { - "name": "Company1", - "type": "text", - "signer": "1", - "x": 128, - "y": 221, - "width": 144, - "height": 14, - "required": true, - "api_id": "279b4e7f-e71f-426d-845c-6308cddde379", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Title1", - "type": "text", - "signer": "1", - "x": 127, - "y": 250, - "width": 144, - "height": 14, - "required": true, - "api_id": "8809e39a-a46c-4dae-aaf9-06fc6355d80f", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "RadioItem2", - "type": "radio", - "signer": "1", - "x": 307, - "y": 253, - "width": 18, - "height": 18, - "required": false, - "api_id": "f7b6b70d-0522-4ab7-bfec-b86f147c8be3", - "group": "0831822584086" - }, - { - "name": "Textbox3", - "type": "text", - "signer": "1", - "x": 410, - "y": 279, - "width": 144, - "height": 14, - "required": true, - "api_id": "bad7512a-e22b-46ed-ba03-123db0eda932", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 38 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox4", - "type": "text", - "signer": "1", - "x": 101, - "y": 314, - "width": 72, - "height": 14, - "required": true, - "api_id": "368ed029-bc93-4f92-8f7a-14c3bf8109b5", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "custom_regex" - }, - { - "name": "Textbox8", - "type": "text", - "signer": "1", - "x": 218, - "y": 313, - "width": 72, - "height": 14, - "required": true, - "api_id": "ecf2ae95-d2e6-41b2-819a-836a6fa8c7c5", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "bank_routing_number" - }, - { - "name": "Textbox12", - "type": "text", - "signer": "1", - "x": 339, - "y": 315, - "width": 72, - "height": 14, - "required": true, - "api_id": "3cb90a0a-a433-4f30-8af8-8fb4c747b704", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "social_security_number" - }, - { - "name": "Textbox9", - "type": "text", - "signer": "1", - "x": 224, - "y": 343, - "width": 72, - "height": 14, - "required": true, - "api_id": "5b9eb331-c97d-435b-a563-d936a9b930c0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "bank_account_number" - }, - { - "name": "Textbox13", - "type": "text", - "signer": "1", - "x": 339, - "y": 345, - "width": 72, - "height": 14, - "required": true, - "api_id": "2b98ce7e-e53a-4cf8-a9f3-d7fb18d88631", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "employer_identification_number" - }, - { - "name": "Textbox5", - "type": "text", - "signer": "1", - "x": 113, - "y": 350, - "width": 72, - "height": 14, - "required": true, - "api_id": "5f52c011-2c5f-4143-bf04-4694fb4a0d3f", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "numbers_only" - }, - { - "name": "Textbox6", - "type": "text", - "signer": "1", - "x": 122, - "y": 374, - "width": 72, - "height": 14, - "required": true, - "api_id": "47457b7d-b1e8-41a0-93ad-60ba30e64bb1", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "letters_only" - }, - { - "name": "Textbox10", - "type": "text", - "signer": "1", - "x": 234, - "y": 373, - "width": 72, - "height": 14, - "required": true, - "api_id": "18e3f994-1675-4d58-9b4a-4f92a2614551", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "email_address" - }, - { - "name": "Textbox14", - "type": "text", - "signer": "1", - "x": 339, - "y": 376, - "width": 72, - "height": 14, - "required": true, - "api_id": "9ad4b8cc-bac9-432b-8836-9f80f86fc7e0", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial" - }, - { - "name": "Textbox7", - "type": "text", - "signer": "1", - "x": 130, - "y": 401, - "width": 72, - "height": 14, - "required": true, - "api_id": "58c5f942-04fb-45f1-9703-5e8411f3a3bb", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "phone_number" - }, - { - "name": "me_now_hyperlink_1", - "type": "hyperlink", - "signer": "me_now", - "x": 434, - "y": 400, - "width": 112, - "height": 14, - "required": false, - "api_id": "fd928b56-cf59-40a4-9a90-62f97ffd0ddc", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 30 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "helvetica" - }, - { - "name": "Textbox11", - "type": "text", - "signer": "1", - "x": 237, - "y": 405, - "width": 72, - "height": 14, - "required": true, - "api_id": "e48c388d-8c26-4f20-848e-f8587a631746", - "avg_text_length": { - "num_lines": 1, - "num_chars_per_line": 19 - }, - "isMultiline": false, - "originalFontSize": 12, - "fontFamily": "arial", - "validation_type": "zip_code" - } - ], "accounts": [ { "account_id": "5008b25c7f67153e57d5a357b1687968068fb465", "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } }, { "account_id": "", "email_address": "teammate@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } + } + ], + "attachments": [ + { + "id": "attachment_1", + "signer": "Outside Vendor", + "name": "Attachment #1", + "required": true } ] } diff --git a/test_fixtures/TemplateListResponse.json b/test_fixtures/TemplateListResponse.json index 7c4768b82..caa5e6d8f 100644 --- a/test_fixtures/TemplateListResponse.json +++ b/test_fixtures/TemplateListResponse.json @@ -12,7 +12,10 @@ "title": "Purchase order", "message": "", "updated_at": 1570471067, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -49,7 +52,8 @@ "originalFontSize": 12, "fontFamily": "arial" } - ] + ], + "static_fields": [] } ], "accounts": [ @@ -58,7 +62,21 @@ "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } + } + ], + "attachments": [ + { + "id": "attachment_1", + "signer": "Outside Vendor", + "name": "Attachment #1", + "required": true } ] }, @@ -67,7 +85,10 @@ "title": "Mutual NDA", "message": "Please sign this NDA as soon as possible.", "updated_at": 1329478947, + "can_edit": true, + "is_creator": true, "is_embedded": false, + "is_locked": false, "metadata": {}, "signer_roles": [ { @@ -564,7 +585,8 @@ "fontFamily": "arial", "validation_type": "zip_code" } - ] + ], + "static_fields": [] } ], "accounts": [ @@ -573,9 +595,16 @@ "email_address": "me@dropboxsign.com", "is_locked": false, "is_paid_hs": false, - "is_paid_hf": false + "is_paid_hf": false, + "quotas": { + "templates_left": 5, + "api_signature_requests_left": 5, + "documents_left": 5, + "sms_verifications_left": 0 + } } - ] + ], + "attachments": [] } ] } From f0865d2d2a7ee6c2eed7060f5c958567646eb88d Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Tue, 15 Oct 2024 17:57:56 -0500 Subject: [PATCH 2/4] Adds a few more non-nullables --- openapi-raw.yaml | 3 + openapi-sdk.yaml | 3 + openapi.yaml | 3 + sdks/dotnet/docs/TemplateResponse.md | 2 +- .../Dropbox.Sign/Model/TemplateResponse.cs | 175 ++++----- sdks/java-v1/docs/TemplateResponse.md | 6 +- .../dropbox/sign/model/TemplateResponse.java | 325 ++++++++--------- sdks/java-v2/docs/TemplateResponse.md | 6 +- .../dropbox/sign/model/TemplateResponse.java | 334 +++++++++--------- sdks/node/dist/api.js | 30 +- sdks/node/docs/model/TemplateResponse.md | 6 +- sdks/node/model/templateResponse.ts | 54 +-- sdks/node/types/model/templateResponse.d.ts | 6 +- sdks/php/docs/Model/TemplateResponse.md | 6 +- sdks/php/src/Model/TemplateResponse.php | 213 +++++------ sdks/python/docs/TemplateResponse.md | 6 +- .../dropbox_sign/models/template_response.py | 98 +++-- sdks/ruby/docs/TemplateResponse.md | 6 +- .../dropbox-sign/models/template_response.rb | 91 +++-- 19 files changed, 711 insertions(+), 662 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 1f41d993e..827695b87 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -10638,10 +10638,13 @@ components: - accounts - attachments - can_edit + - cc_roles - documents - is_creator - is_locked - message + - metadata + - signer_roles - template_id - title properties: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index e6a43ab84..f12bdee8f 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -11254,10 +11254,13 @@ components: - accounts - attachments - can_edit + - cc_roles - documents - is_creator - is_locked - message + - metadata + - signer_roles - template_id - title properties: diff --git a/openapi.yaml b/openapi.yaml index 3a2bb2530..532f0a843 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11232,10 +11232,13 @@ components: - accounts - attachments - can_edit + - cc_roles - documents - is_creator - is_locked - message + - metadata + - signer_roles - template_id - title properties: diff --git a/sdks/dotnet/docs/TemplateResponse.md b/sdks/dotnet/docs/TemplateResponse.md index 22138f9c9..d11fa6417 100644 --- a/sdks/dotnet/docs/TemplateResponse.md +++ b/sdks/dotnet/docs/TemplateResponse.md @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **Metadata** | **Object** | The metadata attached to the template. | [optional] **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] +**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Metadata** | **Object** | The metadata attached to the template. | **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] [[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/TemplateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs index de28dad49..f9385281b 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs @@ -49,9 +49,9 @@ protected TemplateResponse() { } /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. (required). /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). (required). /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. (required). - /// The metadata attached to the template.. - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.. - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.. + /// The metadata attached to the template. (required). + /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. (required). + /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. (required). /// An array describing each document associated with this Template. Includes form field data for each document. (required). /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. /// Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.. @@ -81,6 +81,24 @@ protected TemplateResponse() { } this.IsCreator = isCreator; this.CanEdit = canEdit; this.IsLocked = isLocked; + // to ensure "metadata" is required (not null) + if (metadata == null) + { + throw new ArgumentNullException("metadata is a required property for TemplateResponse and cannot be null"); + } + this.Metadata = metadata; + // to ensure "signerRoles" is required (not null) + if (signerRoles == null) + { + throw new ArgumentNullException("signerRoles is a required property for TemplateResponse and cannot be null"); + } + this.SignerRoles = signerRoles; + // to ensure "ccRoles" is required (not null) + if (ccRoles == null) + { + throw new ArgumentNullException("ccRoles is a required property for TemplateResponse and cannot be null"); + } + this.CcRoles = ccRoles; // to ensure "documents" is required (not null) if (documents == null) { @@ -101,9 +119,6 @@ protected TemplateResponse() { } this.Attachments = attachments; this.UpdatedAt = updatedAt; this.IsEmbedded = isEmbedded; - this.Metadata = metadata; - this.SignerRoles = signerRoles; - this.CcRoles = ccRoles; this.CustomFields = customFields; this.NamedFormFields = namedFormFields; } @@ -166,6 +181,27 @@ public static TemplateResponse Init(string jsonData) [DataMember(Name = "is_locked", IsRequired = true, EmitDefaultValue = true)] public bool IsLocked { get; set; } + /// + /// The metadata attached to the template. + /// + /// The metadata attached to the template. + [DataMember(Name = "metadata", IsRequired = true, EmitDefaultValue = true)] + public Object Metadata { get; set; } + + /// + /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + /// + /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + [DataMember(Name = "signer_roles", IsRequired = true, EmitDefaultValue = true)] + public List SignerRoles { get; set; } + + /// + /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + /// + /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + [DataMember(Name = "cc_roles", IsRequired = true, EmitDefaultValue = true)] + public List CcRoles { get; set; } + /// /// An array describing each document associated with this Template. Includes form field data for each document. /// @@ -201,27 +237,6 @@ public static TemplateResponse Init(string jsonData) [DataMember(Name = "is_embedded", EmitDefaultValue = true)] public bool? IsEmbedded { get; set; } - /// - /// The metadata attached to the template. - /// - /// The metadata attached to the template. - [DataMember(Name = "metadata", EmitDefaultValue = true)] - public Object Metadata { get; set; } - - /// - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. - /// - /// An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. - [DataMember(Name = "signer_roles", EmitDefaultValue = true)] - public List SignerRoles { get; set; } - - /// - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - /// - /// An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - [DataMember(Name = "cc_roles", EmitDefaultValue = true)] - public List CcRoles { get; set; } - /// /// Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. /// @@ -252,14 +267,14 @@ public override string ToString() sb.Append(" IsCreator: ").Append(IsCreator).Append("\n"); sb.Append(" CanEdit: ").Append(CanEdit).Append("\n"); sb.Append(" IsLocked: ").Append(IsLocked).Append("\n"); + sb.Append(" Metadata: ").Append(Metadata).Append("\n"); + sb.Append(" SignerRoles: ").Append(SignerRoles).Append("\n"); + sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" Documents: ").Append(Documents).Append("\n"); sb.Append(" Accounts: ").Append(Accounts).Append("\n"); sb.Append(" Attachments: ").Append(Attachments).Append("\n"); sb.Append(" UpdatedAt: ").Append(UpdatedAt).Append("\n"); sb.Append(" IsEmbedded: ").Append(IsEmbedded).Append("\n"); - sb.Append(" Metadata: ").Append(Metadata).Append("\n"); - sb.Append(" SignerRoles: ").Append(SignerRoles).Append("\n"); - sb.Append(" CcRoles: ").Append(CcRoles).Append("\n"); sb.Append(" CustomFields: ").Append(CustomFields).Append("\n"); sb.Append(" NamedFormFields: ").Append(NamedFormFields).Append("\n"); sb.Append("}\n"); @@ -324,6 +339,23 @@ public bool Equals(TemplateResponse input) this.IsLocked == input.IsLocked || this.IsLocked.Equals(input.IsLocked) ) && + ( + this.Metadata == input.Metadata || + (this.Metadata != null && + this.Metadata.Equals(input.Metadata)) + ) && + ( + this.SignerRoles == input.SignerRoles || + this.SignerRoles != null && + input.SignerRoles != null && + this.SignerRoles.SequenceEqual(input.SignerRoles) + ) && + ( + this.CcRoles == input.CcRoles || + this.CcRoles != null && + input.CcRoles != null && + this.CcRoles.SequenceEqual(input.CcRoles) + ) && ( this.Documents == input.Documents || this.Documents != null && @@ -351,23 +383,6 @@ public bool Equals(TemplateResponse input) (this.IsEmbedded != null && this.IsEmbedded.Equals(input.IsEmbedded)) ) && - ( - this.Metadata == input.Metadata || - (this.Metadata != null && - this.Metadata.Equals(input.Metadata)) - ) && - ( - this.SignerRoles == input.SignerRoles || - this.SignerRoles != null && - input.SignerRoles != null && - this.SignerRoles.SequenceEqual(input.SignerRoles) - ) && - ( - this.CcRoles == input.CcRoles || - this.CcRoles != null && - input.CcRoles != null && - this.CcRoles.SequenceEqual(input.CcRoles) - ) && ( this.CustomFields == input.CustomFields || this.CustomFields != null && @@ -406,6 +421,18 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.IsCreator.GetHashCode(); hashCode = (hashCode * 59) + this.CanEdit.GetHashCode(); hashCode = (hashCode * 59) + this.IsLocked.GetHashCode(); + if (this.Metadata != null) + { + hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); + } + if (this.SignerRoles != null) + { + hashCode = (hashCode * 59) + this.SignerRoles.GetHashCode(); + } + if (this.CcRoles != null) + { + hashCode = (hashCode * 59) + this.CcRoles.GetHashCode(); + } if (this.Documents != null) { hashCode = (hashCode * 59) + this.Documents.GetHashCode(); @@ -423,18 +450,6 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.IsEmbedded.GetHashCode(); } - if (this.Metadata != null) - { - hashCode = (hashCode * 59) + this.Metadata.GetHashCode(); - } - if (this.SignerRoles != null) - { - hashCode = (hashCode * 59) + this.SignerRoles.GetHashCode(); - } - if (this.CcRoles != null) - { - hashCode = (hashCode * 59) + this.CcRoles.GetHashCode(); - } if (this.CustomFields != null) { hashCode = (hashCode * 59) + this.CustomFields.GetHashCode(); @@ -502,6 +517,27 @@ public List GetOpenApiTypes() Value = IsLocked, }); types.Add(new OpenApiType() + { + Name = "metadata", + Property = "Metadata", + Type = "Object", + Value = Metadata, + }); + types.Add(new OpenApiType() + { + Name = "signer_roles", + Property = "SignerRoles", + Type = "List", + Value = SignerRoles, + }); + types.Add(new OpenApiType() + { + Name = "cc_roles", + Property = "CcRoles", + Type = "List", + Value = CcRoles, + }); + types.Add(new OpenApiType() { Name = "documents", Property = "Documents", @@ -537,27 +573,6 @@ public List GetOpenApiTypes() Value = IsEmbedded, }); types.Add(new OpenApiType() - { - Name = "metadata", - Property = "Metadata", - Type = "Object", - Value = Metadata, - }); - types.Add(new OpenApiType() - { - Name = "signer_roles", - Property = "SignerRoles", - Type = "List", - Value = SignerRoles, - }); - types.Add(new OpenApiType() - { - Name = "cc_roles", - Property = "CcRoles", - Type = "List", - Value = CcRoles, - }); - types.Add(new OpenApiType() { Name = "custom_fields", Property = "CustomFields", diff --git a/sdks/java-v1/docs/TemplateResponse.md b/sdks/java-v1/docs/TemplateResponse.md index 323e905f6..33bace8ba 100644 --- a/sdks/java-v1/docs/TemplateResponse.md +++ b/sdks/java-v1/docs/TemplateResponse.md @@ -14,14 +14,14 @@ Contains information about the templates you and your team have created. | `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | | `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | | `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | +| `signerRoles`*_required_ | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles`*_required_ | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | | `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `metadata` | ```Object``` | The metadata attached to the template. | | -| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 5cc3dcde9..4f5ecd488 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -33,14 +33,14 @@ TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, + TemplateResponse.JSON_PROPERTY_METADATA, + TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, + TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_DOCUMENTS, TemplateResponse.JSON_PROPERTY_ACCOUNTS, TemplateResponse.JSON_PROPERTY_ATTACHMENTS, TemplateResponse.JSON_PROPERTY_UPDATED_AT, TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, - TemplateResponse.JSON_PROPERTY_METADATA, - TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, - TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS }) @@ -67,6 +67,15 @@ public class TemplateResponse { public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Object metadata; + + public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; + private List signerRoles = new ArrayList<>(); + + public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; + private List ccRoles = new ArrayList<>(); + public static final String JSON_PROPERTY_DOCUMENTS = "documents"; private List documents = new ArrayList<>(); @@ -82,15 +91,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; private Boolean isEmbedded; - public static final String JSON_PROPERTY_METADATA = "metadata"; - private Object metadata; - - public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; - private List signerRoles = null; - - public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; - private List ccRoles = null; - public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated private List customFields = null; @@ -258,6 +258,93 @@ public void setIsLocked(Boolean isLocked) { this.isLocked = isLocked; } + public TemplateResponse metadata(Object metadata) { + this.metadata = metadata; + return this; + } + + /** + * The metadata attached to the template. + * + * @return metadata + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public Object getMetadata() { + return metadata; + } + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setMetadata(Object metadata) { + this.metadata = metadata; + } + + public TemplateResponse signerRoles(List signerRoles) { + this.signerRoles = signerRoles; + return this; + } + + public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRolesItem) { + if (this.signerRoles == null) { + this.signerRoles = new ArrayList<>(); + } + this.signerRoles.add(signerRolesItem); + return this; + } + + /** + * An array of the designated signer roles that must be specified when sending a + * SignatureRequest using this Template. + * + * @return signerRoles + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getSignerRoles() { + return signerRoles; + } + + @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSignerRoles(List signerRoles) { + this.signerRoles = signerRoles; + } + + public TemplateResponse ccRoles(List ccRoles) { + this.ccRoles = ccRoles; + return this; + } + + public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { + if (this.ccRoles == null) { + this.ccRoles = new ArrayList<>(); + } + this.ccRoles.add(ccRolesItem); + return this; + } + + /** + * An array of the designated CC roles that must be specified when sending a SignatureRequest + * using this Template. + * + * @return ccRoles + */ + @javax.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CC_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public List getCcRoles() { + return ccRoles; + } + + @JsonProperty(JSON_PROPERTY_CC_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCcRoles(List ccRoles) { + this.ccRoles = ccRoles; + } + public TemplateResponse documents(List documents) { this.documents = documents; return this; @@ -397,90 +484,6 @@ public void setIsEmbedded(Boolean isEmbedded) { this.isEmbedded = isEmbedded; } - public TemplateResponse metadata(Object metadata) { - this.metadata = metadata; - return this; - } - - /** - * The metadata attached to the template. - * - * @return metadata - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Object getMetadata() { - return metadata; - } - - @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Object metadata) { - this.metadata = metadata; - } - - public TemplateResponse signerRoles(List signerRoles) { - this.signerRoles = signerRoles; - return this; - } - - public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRolesItem) { - if (this.signerRoles == null) { - this.signerRoles = new ArrayList<>(); - } - this.signerRoles.add(signerRolesItem); - return this; - } - - /** - * An array of the designated signer roles that must be specified when sending a - * SignatureRequest using this Template. - * - * @return signerRoles - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public List getSignerRoles() { - return signerRoles; - } - - @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerRoles(List signerRoles) { - this.signerRoles = signerRoles; - } - - public TemplateResponse ccRoles(List ccRoles) { - this.ccRoles = ccRoles; - return this; - } - - public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { - if (this.ccRoles == null) { - this.ccRoles = new ArrayList<>(); - } - this.ccRoles.add(ccRolesItem); - return this; - } - - /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest - * using this Template. - * - * @return ccRoles - */ - @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public List getCcRoles() { - return ccRoles; - } - - @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcRoles(List ccRoles) { - this.ccRoles = ccRoles; - } - @Deprecated public TemplateResponse customFields( List customFields) { @@ -573,14 +576,14 @@ public boolean equals(Object o) { && Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) + && Objects.equals(this.metadata, templateResponse.metadata) + && Objects.equals(this.signerRoles, templateResponse.signerRoles) + && Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.documents, templateResponse.documents) && Objects.equals(this.accounts, templateResponse.accounts) && Objects.equals(this.attachments, templateResponse.attachments) && Objects.equals(this.updatedAt, templateResponse.updatedAt) && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) - && Objects.equals(this.metadata, templateResponse.metadata) - && Objects.equals(this.signerRoles, templateResponse.signerRoles) - && Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.customFields, templateResponse.customFields) && Objects.equals(this.namedFormFields, templateResponse.namedFormFields); } @@ -594,14 +597,14 @@ public int hashCode() { isCreator, canEdit, isLocked, + metadata, + signerRoles, + ccRoles, documents, accounts, attachments, updatedAt, isEmbedded, - metadata, - signerRoles, - ccRoles, customFields, namedFormFields); } @@ -616,14 +619,14 @@ public String toString() { sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); + sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); - sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); - sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); - sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); sb.append("}"); @@ -748,6 +751,62 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(isLocked)); } } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) + || metadata.getClass().equals(Integer.class) + || metadata.getClass().equals(String.class) + || metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for (int i = 0; i < getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signerRoles != null) { + if (isFileTypeOrListOfFiles(signerRoles)) { + fileTypeFound = true; + } + + if (signerRoles.getClass().equals(java.io.File.class) + || signerRoles.getClass().equals(Integer.class) + || signerRoles.getClass().equals(String.class) + || signerRoles.getClass().isEnum()) { + map.put("signer_roles", signerRoles); + } else if (isListOfFile(signerRoles)) { + for (int i = 0; i < getListSize(signerRoles); i++) { + map.put("signer_roles[" + i + "]", getFromList(signerRoles, i)); + } + } else { + map.put( + "signer_roles", + JSON.getDefault().getMapper().writeValueAsString(signerRoles)); + } + } + if (ccRoles != null) { + if (isFileTypeOrListOfFiles(ccRoles)) { + fileTypeFound = true; + } + + if (ccRoles.getClass().equals(java.io.File.class) + || ccRoles.getClass().equals(Integer.class) + || ccRoles.getClass().equals(String.class) + || ccRoles.getClass().isEnum()) { + map.put("cc_roles", ccRoles); + } else if (isListOfFile(ccRoles)) { + for (int i = 0; i < getListSize(ccRoles); i++) { + map.put("cc_roles[" + i + "]", getFromList(ccRoles, i)); + } + } else { + map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); + } + } if (documents != null) { if (isFileTypeOrListOfFiles(documents)) { fileTypeFound = true; @@ -846,62 +905,6 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); } } - if (metadata != null) { - if (isFileTypeOrListOfFiles(metadata)) { - fileTypeFound = true; - } - - if (metadata.getClass().equals(java.io.File.class) - || metadata.getClass().equals(Integer.class) - || metadata.getClass().equals(String.class) - || metadata.getClass().isEnum()) { - map.put("metadata", metadata); - } else if (isListOfFile(metadata)) { - for (int i = 0; i < getListSize(metadata); i++) { - map.put("metadata[" + i + "]", getFromList(metadata, i)); - } - } else { - map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); - } - } - if (signerRoles != null) { - if (isFileTypeOrListOfFiles(signerRoles)) { - fileTypeFound = true; - } - - if (signerRoles.getClass().equals(java.io.File.class) - || signerRoles.getClass().equals(Integer.class) - || signerRoles.getClass().equals(String.class) - || signerRoles.getClass().isEnum()) { - map.put("signer_roles", signerRoles); - } else if (isListOfFile(signerRoles)) { - for (int i = 0; i < getListSize(signerRoles); i++) { - map.put("signer_roles[" + i + "]", getFromList(signerRoles, i)); - } - } else { - map.put( - "signer_roles", - JSON.getDefault().getMapper().writeValueAsString(signerRoles)); - } - } - if (ccRoles != null) { - if (isFileTypeOrListOfFiles(ccRoles)) { - fileTypeFound = true; - } - - if (ccRoles.getClass().equals(java.io.File.class) - || ccRoles.getClass().equals(Integer.class) - || ccRoles.getClass().equals(String.class) - || ccRoles.getClass().isEnum()) { - map.put("cc_roles", ccRoles); - } else if (isListOfFile(ccRoles)) { - for (int i = 0; i < getListSize(ccRoles); i++) { - map.put("cc_roles[" + i + "]", getFromList(ccRoles, i)); - } - } else { - map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); - } - } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; diff --git a/sdks/java-v2/docs/TemplateResponse.md b/sdks/java-v2/docs/TemplateResponse.md index 323e905f6..33bace8ba 100644 --- a/sdks/java-v2/docs/TemplateResponse.md +++ b/sdks/java-v2/docs/TemplateResponse.md @@ -14,14 +14,14 @@ Contains information about the templates you and your team have created. | `isCreator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | | `canEdit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | | `isLocked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | +| `signerRoles`*_required_ | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles`*_required_ | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `documents`*_required_ | [```List```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | | `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `metadata` | ```Object``` | The metadata attached to the template. | | -| `signerRoles` | [```List```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```List```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java index f78dfbb26..8d6a81f44 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -48,14 +48,14 @@ TemplateResponse.JSON_PROPERTY_IS_CREATOR, TemplateResponse.JSON_PROPERTY_CAN_EDIT, TemplateResponse.JSON_PROPERTY_IS_LOCKED, + TemplateResponse.JSON_PROPERTY_METADATA, + TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, + TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_DOCUMENTS, TemplateResponse.JSON_PROPERTY_ACCOUNTS, TemplateResponse.JSON_PROPERTY_ATTACHMENTS, TemplateResponse.JSON_PROPERTY_UPDATED_AT, TemplateResponse.JSON_PROPERTY_IS_EMBEDDED, - TemplateResponse.JSON_PROPERTY_METADATA, - TemplateResponse.JSON_PROPERTY_SIGNER_ROLES, - TemplateResponse.JSON_PROPERTY_CC_ROLES, TemplateResponse.JSON_PROPERTY_CUSTOM_FIELDS, TemplateResponse.JSON_PROPERTY_NAMED_FORM_FIELDS }) @@ -80,6 +80,15 @@ public class TemplateResponse { public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; private Boolean isLocked; + public static final String JSON_PROPERTY_METADATA = "metadata"; + private Object metadata; + + public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; + private List signerRoles = new ArrayList<>(); + + public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; + private List ccRoles = new ArrayList<>(); + public static final String JSON_PROPERTY_DOCUMENTS = "documents"; private List documents = new ArrayList<>(); @@ -95,15 +104,6 @@ public class TemplateResponse { public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; private Boolean isEmbedded; - public static final String JSON_PROPERTY_METADATA = "metadata"; - private Object metadata; - - public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; - private List signerRoles = null; - - public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; - private List ccRoles = null; - public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated private List customFields = null; @@ -280,6 +280,97 @@ public void setIsLocked(Boolean isLocked) { } + public TemplateResponse metadata(Object metadata) { + this.metadata = metadata; + return this; + } + + /** + * The metadata attached to the template. + * @return metadata + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public Object getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setMetadata(Object metadata) { + this.metadata = metadata; + } + + + public TemplateResponse signerRoles(List signerRoles) { + this.signerRoles = signerRoles; + return this; + } + + public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRolesItem) { + if (this.signerRoles == null) { + this.signerRoles = new ArrayList<>(); + } + this.signerRoles.add(signerRolesItem); + return this; + } + + /** + * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + * @return signerRoles + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getSignerRoles() { + return signerRoles; + } + + + @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSignerRoles(List signerRoles) { + this.signerRoles = signerRoles; + } + + + public TemplateResponse ccRoles(List ccRoles) { + this.ccRoles = ccRoles; + return this; + } + + public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { + if (this.ccRoles == null) { + this.ccRoles = new ArrayList<>(); + } + this.ccRoles.add(ccRolesItem); + return this; + } + + /** + * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + * @return ccRoles + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CC_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getCcRoles() { + return ccRoles; + } + + + @JsonProperty(JSON_PROPERTY_CC_ROLES) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCcRoles(List ccRoles) { + this.ccRoles = ccRoles; + } + + public TemplateResponse documents(List documents) { this.documents = documents; return this; @@ -429,97 +520,6 @@ public void setIsEmbedded(Boolean isEmbedded) { } - public TemplateResponse metadata(Object metadata) { - this.metadata = metadata; - return this; - } - - /** - * The metadata attached to the template. - * @return metadata - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public Object getMetadata() { - return metadata; - } - - - @JsonProperty(JSON_PROPERTY_METADATA) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Object metadata) { - this.metadata = metadata; - } - - - public TemplateResponse signerRoles(List signerRoles) { - this.signerRoles = signerRoles; - return this; - } - - public TemplateResponse addSignerRolesItem(TemplateResponseSignerRole signerRolesItem) { - if (this.signerRoles == null) { - this.signerRoles = new ArrayList<>(); - } - this.signerRoles.add(signerRolesItem); - return this; - } - - /** - * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. - * @return signerRoles - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getSignerRoles() { - return signerRoles; - } - - - @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerRoles(List signerRoles) { - this.signerRoles = signerRoles; - } - - - public TemplateResponse ccRoles(List ccRoles) { - this.ccRoles = ccRoles; - return this; - } - - public TemplateResponse addCcRolesItem(TemplateResponseCCRole ccRolesItem) { - if (this.ccRoles == null) { - this.ccRoles = new ArrayList<>(); - } - this.ccRoles.add(ccRolesItem); - return this; - } - - /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - * @return ccRoles - */ - @jakarta.annotation.Nullable - @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public List getCcRoles() { - return ccRoles; - } - - - @JsonProperty(JSON_PROPERTY_CC_ROLES) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcRoles(List ccRoles) { - this.ccRoles = ccRoles; - } - - @Deprecated public TemplateResponse customFields(List customFields) { this.customFields = customFields; @@ -612,21 +612,21 @@ public boolean equals(Object o) { Objects.equals(this.isCreator, templateResponse.isCreator) && Objects.equals(this.canEdit, templateResponse.canEdit) && Objects.equals(this.isLocked, templateResponse.isLocked) && + Objects.equals(this.metadata, templateResponse.metadata) && + Objects.equals(this.signerRoles, templateResponse.signerRoles) && + Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.documents, templateResponse.documents) && Objects.equals(this.accounts, templateResponse.accounts) && Objects.equals(this.attachments, templateResponse.attachments) && Objects.equals(this.updatedAt, templateResponse.updatedAt) && Objects.equals(this.isEmbedded, templateResponse.isEmbedded) && - Objects.equals(this.metadata, templateResponse.metadata) && - Objects.equals(this.signerRoles, templateResponse.signerRoles) && - Objects.equals(this.ccRoles, templateResponse.ccRoles) && Objects.equals(this.customFields, templateResponse.customFields) && Objects.equals(this.namedFormFields, templateResponse.namedFormFields); } @Override public int hashCode() { - return Objects.hash(templateId, title, message, isCreator, canEdit, isLocked, documents, accounts, attachments, updatedAt, isEmbedded, metadata, signerRoles, ccRoles, customFields, namedFormFields); + return Objects.hash(templateId, title, message, isCreator, canEdit, isLocked, metadata, signerRoles, ccRoles, documents, accounts, attachments, updatedAt, isEmbedded, customFields, namedFormFields); } @Override @@ -639,14 +639,14 @@ public String toString() { sb.append(" isCreator: ").append(toIndentedString(isCreator)).append("\n"); sb.append(" canEdit: ").append(toIndentedString(canEdit)).append("\n"); sb.append(" isLocked: ").append(toIndentedString(isLocked)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); + sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" documents: ").append(toIndentedString(documents)).append("\n"); sb.append(" accounts: ").append(toIndentedString(accounts)).append("\n"); sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n"); sb.append(" isEmbedded: ").append(toIndentedString(isEmbedded)).append("\n"); - sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); - sb.append(" signerRoles: ").append(toIndentedString(signerRoles)).append("\n"); - sb.append(" ccRoles: ").append(toIndentedString(ccRoles)).append("\n"); sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); sb.append(" namedFormFields: ").append(toIndentedString(namedFormFields)).append("\n"); sb.append("}"); @@ -771,6 +771,63 @@ public Map createFormData() throws ApiException { map.put("is_locked", JSON.getDefault().getMapper().writeValueAsString(isLocked)); } } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signerRoles != null) { + if (isFileTypeOrListOfFiles(signerRoles)) { + fileTypeFound = true; + } + + if (signerRoles.getClass().equals(java.io.File.class) || + signerRoles.getClass().equals(Integer.class) || + signerRoles.getClass().equals(String.class) || + signerRoles.getClass().isEnum()) { + map.put("signer_roles", signerRoles); + } else if (isListOfFile(signerRoles)) { + for(int i = 0; i< getListSize(signerRoles); i++) { + map.put("signer_roles[" + i + "]", getFromList(signerRoles, i)); + } + } + else { + map.put("signer_roles", JSON.getDefault().getMapper().writeValueAsString(signerRoles)); + } + } + if (ccRoles != null) { + if (isFileTypeOrListOfFiles(ccRoles)) { + fileTypeFound = true; + } + + if (ccRoles.getClass().equals(java.io.File.class) || + ccRoles.getClass().equals(Integer.class) || + ccRoles.getClass().equals(String.class) || + ccRoles.getClass().isEnum()) { + map.put("cc_roles", ccRoles); + } else if (isListOfFile(ccRoles)) { + for(int i = 0; i< getListSize(ccRoles); i++) { + map.put("cc_roles[" + i + "]", getFromList(ccRoles, i)); + } + } + else { + map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); + } + } if (documents != null) { if (isFileTypeOrListOfFiles(documents)) { fileTypeFound = true; @@ -866,63 +923,6 @@ public Map createFormData() throws ApiException { map.put("is_embedded", JSON.getDefault().getMapper().writeValueAsString(isEmbedded)); } } - if (metadata != null) { - if (isFileTypeOrListOfFiles(metadata)) { - fileTypeFound = true; - } - - if (metadata.getClass().equals(java.io.File.class) || - metadata.getClass().equals(Integer.class) || - metadata.getClass().equals(String.class) || - metadata.getClass().isEnum()) { - map.put("metadata", metadata); - } else if (isListOfFile(metadata)) { - for(int i = 0; i< getListSize(metadata); i++) { - map.put("metadata[" + i + "]", getFromList(metadata, i)); - } - } - else { - map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); - } - } - if (signerRoles != null) { - if (isFileTypeOrListOfFiles(signerRoles)) { - fileTypeFound = true; - } - - if (signerRoles.getClass().equals(java.io.File.class) || - signerRoles.getClass().equals(Integer.class) || - signerRoles.getClass().equals(String.class) || - signerRoles.getClass().isEnum()) { - map.put("signer_roles", signerRoles); - } else if (isListOfFile(signerRoles)) { - for(int i = 0; i< getListSize(signerRoles); i++) { - map.put("signer_roles[" + i + "]", getFromList(signerRoles, i)); - } - } - else { - map.put("signer_roles", JSON.getDefault().getMapper().writeValueAsString(signerRoles)); - } - } - if (ccRoles != null) { - if (isFileTypeOrListOfFiles(ccRoles)) { - fileTypeFound = true; - } - - if (ccRoles.getClass().equals(java.io.File.class) || - ccRoles.getClass().equals(Integer.class) || - ccRoles.getClass().equals(String.class) || - ccRoles.getClass().isEnum()) { - map.put("cc_roles", ccRoles); - } else if (isListOfFile(ccRoles)) { - for(int i = 0; i< getListSize(ccRoles); i++) { - map.put("cc_roles[" + i + "]", getFromList(ccRoles, i)); - } - } - else { - map.put("cc_roles", JSON.getDefault().getMapper().writeValueAsString(ccRoles)); - } - } if (customFields != null) { if (isFileTypeOrListOfFiles(customFields)) { fileTypeFound = true; diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index 8c6997d8f..e1b290ca1 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -22508,6 +22508,21 @@ TemplateResponse.attributeTypeMap = [ baseName: "is_locked", type: "boolean" }, + { + name: "metadata", + baseName: "metadata", + type: "object" + }, + { + name: "signerRoles", + baseName: "signer_roles", + type: "Array" + }, + { + name: "ccRoles", + baseName: "cc_roles", + type: "Array" + }, { name: "documents", baseName: "documents", @@ -22533,21 +22548,6 @@ TemplateResponse.attributeTypeMap = [ baseName: "is_embedded", type: "boolean" }, - { - name: "metadata", - baseName: "metadata", - type: "object" - }, - { - name: "signerRoles", - baseName: "signer_roles", - type: "Array" - }, - { - name: "ccRoles", - baseName: "cc_roles", - type: "Array" - }, { name: "customFields", baseName: "custom_fields", diff --git a/sdks/node/docs/model/TemplateResponse.md b/sdks/node/docs/model/TemplateResponse.md index 611a51c41..30d0e258e 100644 --- a/sdks/node/docs/model/TemplateResponse.md +++ b/sdks/node/docs/model/TemplateResponse.md @@ -12,14 +12,14 @@ Name | Type | Description | Notes | `isCreator`*_required_ | ```boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | | `canEdit`*_required_ | ```boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | | `isLocked`*_required_ | ```boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```object``` | The metadata attached to the template. | | +| `signerRoles`*_required_ | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `ccRoles`*_required_ | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```number``` | Time the template was last updated. | | | `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `metadata` | ```object``` | The metadata attached to the template. | | -| `signerRoles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `ccRoles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/node/model/templateResponse.ts b/sdks/node/model/templateResponse.ts index 53158e8d7..383a1d3bd 100644 --- a/sdks/node/model/templateResponse.ts +++ b/sdks/node/model/templateResponse.ts @@ -59,6 +59,18 @@ export class TemplateResponse { * Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. */ "isLocked": boolean; + /** + * The metadata attached to the template. + */ + "metadata": object; + /** + * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + */ + "signerRoles": Array; + /** + * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + */ + "ccRoles": Array; /** * An array describing each document associated with this Template. Includes form field data for each document. */ @@ -79,18 +91,6 @@ export class TemplateResponse { * `true` if this template was created using an embedded flow, `false` if it was created on our website. */ "isEmbedded"?: boolean | null; - /** - * The metadata attached to the template. - */ - "metadata"?: object; - /** - * An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. - */ - "signerRoles"?: Array; - /** - * An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - */ - "ccRoles"?: Array; /** * Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. */ @@ -133,6 +133,21 @@ export class TemplateResponse { baseName: "is_locked", type: "boolean", }, + { + name: "metadata", + baseName: "metadata", + type: "object", + }, + { + name: "signerRoles", + baseName: "signer_roles", + type: "Array", + }, + { + name: "ccRoles", + baseName: "cc_roles", + type: "Array", + }, { name: "documents", baseName: "documents", @@ -158,21 +173,6 @@ export class TemplateResponse { baseName: "is_embedded", type: "boolean", }, - { - name: "metadata", - baseName: "metadata", - type: "object", - }, - { - name: "signerRoles", - baseName: "signer_roles", - type: "Array", - }, - { - name: "ccRoles", - baseName: "cc_roles", - type: "Array", - }, { name: "customFields", baseName: "custom_fields", diff --git a/sdks/node/types/model/templateResponse.d.ts b/sdks/node/types/model/templateResponse.d.ts index 655c23adc..a53df471b 100644 --- a/sdks/node/types/model/templateResponse.d.ts +++ b/sdks/node/types/model/templateResponse.d.ts @@ -13,14 +13,14 @@ export declare class TemplateResponse { "isCreator": boolean; "canEdit": boolean; "isLocked": boolean; + "metadata": object; + "signerRoles": Array; + "ccRoles": Array; "documents": Array; "accounts": Array; "attachments": Array; "updatedAt"?: number; "isEmbedded"?: boolean | null; - "metadata"?: object; - "signerRoles"?: Array; - "ccRoles"?: Array; "customFields"?: Array | null; "namedFormFields"?: Array | null; static discriminator: string | undefined; diff --git a/sdks/php/docs/Model/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index ba33b6011..030cdc0e1 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -12,14 +12,14 @@ Name | Type | Description | Notes | `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | | `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | | `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```array``` | The metadata attached to the template. | | +| `signer_roles`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `documents`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseDocument[]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `accounts`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | | `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `metadata` | ```array``` | The metadata attached to the template. | | -| `signer_roles` | [```\Dropbox\Sign\Model\TemplateResponseSignerRole[]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```\Dropbox\Sign\Model\TemplateResponseCCRole[]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index b16bbe7d1..9c413ccc2 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -64,14 +64,14 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'is_creator' => 'bool', 'can_edit' => 'bool', 'is_locked' => 'bool', + 'metadata' => 'array', + 'signer_roles' => '\Dropbox\Sign\Model\TemplateResponseSignerRole[]', + 'cc_roles' => '\Dropbox\Sign\Model\TemplateResponseCCRole[]', 'documents' => '\Dropbox\Sign\Model\TemplateResponseDocument[]', 'accounts' => '\Dropbox\Sign\Model\TemplateResponseAccount[]', 'attachments' => '\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]', 'updated_at' => 'int', 'is_embedded' => 'bool', - 'metadata' => 'array', - 'signer_roles' => '\Dropbox\Sign\Model\TemplateResponseSignerRole[]', - 'cc_roles' => '\Dropbox\Sign\Model\TemplateResponseCCRole[]', 'custom_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]', 'named_form_fields' => '\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]', ]; @@ -90,14 +90,14 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'is_creator' => null, 'can_edit' => null, 'is_locked' => null, + 'metadata' => null, + 'signer_roles' => null, + 'cc_roles' => null, 'documents' => null, 'accounts' => null, 'attachments' => null, 'updated_at' => null, 'is_embedded' => null, - 'metadata' => null, - 'signer_roles' => null, - 'cc_roles' => null, 'custom_fields' => null, 'named_form_fields' => null, ]; @@ -114,14 +114,14 @@ class TemplateResponse implements ModelInterface, ArrayAccess, JsonSerializable 'is_creator' => false, 'can_edit' => false, 'is_locked' => false, + 'metadata' => false, + 'signer_roles' => false, + 'cc_roles' => false, 'documents' => false, 'accounts' => false, 'attachments' => false, 'updated_at' => false, 'is_embedded' => true, - 'metadata' => false, - 'signer_roles' => false, - 'cc_roles' => false, 'custom_fields' => true, 'named_form_fields' => true, ]; @@ -210,14 +210,14 @@ public function isNullableSetToNull(string $property): bool 'is_creator' => 'is_creator', 'can_edit' => 'can_edit', 'is_locked' => 'is_locked', + 'metadata' => 'metadata', + 'signer_roles' => 'signer_roles', + 'cc_roles' => 'cc_roles', 'documents' => 'documents', 'accounts' => 'accounts', 'attachments' => 'attachments', 'updated_at' => 'updated_at', 'is_embedded' => 'is_embedded', - 'metadata' => 'metadata', - 'signer_roles' => 'signer_roles', - 'cc_roles' => 'cc_roles', 'custom_fields' => 'custom_fields', 'named_form_fields' => 'named_form_fields', ]; @@ -234,14 +234,14 @@ public function isNullableSetToNull(string $property): bool 'is_creator' => 'setIsCreator', 'can_edit' => 'setCanEdit', 'is_locked' => 'setIsLocked', + 'metadata' => 'setMetadata', + 'signer_roles' => 'setSignerRoles', + 'cc_roles' => 'setCcRoles', 'documents' => 'setDocuments', 'accounts' => 'setAccounts', 'attachments' => 'setAttachments', 'updated_at' => 'setUpdatedAt', 'is_embedded' => 'setIsEmbedded', - 'metadata' => 'setMetadata', - 'signer_roles' => 'setSignerRoles', - 'cc_roles' => 'setCcRoles', 'custom_fields' => 'setCustomFields', 'named_form_fields' => 'setNamedFormFields', ]; @@ -258,14 +258,14 @@ public function isNullableSetToNull(string $property): bool 'is_creator' => 'getIsCreator', 'can_edit' => 'getCanEdit', 'is_locked' => 'getIsLocked', + 'metadata' => 'getMetadata', + 'signer_roles' => 'getSignerRoles', + 'cc_roles' => 'getCcRoles', 'documents' => 'getDocuments', 'accounts' => 'getAccounts', 'attachments' => 'getAttachments', 'updated_at' => 'getUpdatedAt', 'is_embedded' => 'getIsEmbedded', - 'metadata' => 'getMetadata', - 'signer_roles' => 'getSignerRoles', - 'cc_roles' => 'getCcRoles', 'custom_fields' => 'getCustomFields', 'named_form_fields' => 'getNamedFormFields', ]; @@ -332,14 +332,14 @@ public function __construct(array $data = null) $this->setIfExists('is_creator', $data ?? [], null); $this->setIfExists('can_edit', $data ?? [], null); $this->setIfExists('is_locked', $data ?? [], null); + $this->setIfExists('metadata', $data ?? [], null); + $this->setIfExists('signer_roles', $data ?? [], null); + $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('documents', $data ?? [], null); $this->setIfExists('accounts', $data ?? [], null); $this->setIfExists('attachments', $data ?? [], null); $this->setIfExists('updated_at', $data ?? [], null); $this->setIfExists('is_embedded', $data ?? [], null); - $this->setIfExists('metadata', $data ?? [], null); - $this->setIfExists('signer_roles', $data ?? [], null); - $this->setIfExists('cc_roles', $data ?? [], null); $this->setIfExists('custom_fields', $data ?? [], null); $this->setIfExists('named_form_fields', $data ?? [], null); } @@ -407,6 +407,15 @@ public function listInvalidProperties() if ($this->container['is_locked'] === null) { $invalidProperties[] = "'is_locked' can't be null"; } + if ($this->container['metadata'] === null) { + $invalidProperties[] = "'metadata' can't be null"; + } + if ($this->container['signer_roles'] === null) { + $invalidProperties[] = "'signer_roles' can't be null"; + } + if ($this->container['cc_roles'] === null) { + $invalidProperties[] = "'cc_roles' can't be null"; + } if ($this->container['documents'] === null) { $invalidProperties[] = "'documents' can't be null"; } @@ -592,6 +601,87 @@ public function setIsLocked(bool $is_locked) return $this; } + /** + * Gets metadata + * + * @return array + */ + public function getMetadata() + { + return $this->container['metadata']; + } + + /** + * Sets metadata + * + * @param array $metadata the metadata attached to the template + * + * @return self + */ + public function setMetadata(array $metadata) + { + if (is_null($metadata)) { + throw new InvalidArgumentException('non-nullable metadata cannot be null'); + } + $this->container['metadata'] = $metadata; + + return $this; + } + + /** + * Gets signer_roles + * + * @return TemplateResponseSignerRole[] + */ + public function getSignerRoles() + { + return $this->container['signer_roles']; + } + + /** + * Sets signer_roles + * + * @param TemplateResponseSignerRole[] $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template + * + * @return self + */ + public function setSignerRoles(array $signer_roles) + { + if (is_null($signer_roles)) { + throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); + } + $this->container['signer_roles'] = $signer_roles; + + return $this; + } + + /** + * Gets cc_roles + * + * @return TemplateResponseCCRole[] + */ + public function getCcRoles() + { + return $this->container['cc_roles']; + } + + /** + * Sets cc_roles + * + * @param TemplateResponseCCRole[] $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template + * + * @return self + */ + public function setCcRoles(array $cc_roles) + { + if (is_null($cc_roles)) { + throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); + } + $this->container['cc_roles'] = $cc_roles; + + return $this; + } + /** * Gets documents * @@ -734,87 +824,6 @@ public function setIsEmbedded(?bool $is_embedded) return $this; } - /** - * Gets metadata - * - * @return array|null - */ - public function getMetadata() - { - return $this->container['metadata']; - } - - /** - * Sets metadata - * - * @param array|null $metadata the metadata attached to the template - * - * @return self - */ - public function setMetadata(?array $metadata) - { - if (is_null($metadata)) { - throw new InvalidArgumentException('non-nullable metadata cannot be null'); - } - $this->container['metadata'] = $metadata; - - return $this; - } - - /** - * Gets signer_roles - * - * @return TemplateResponseSignerRole[]|null - */ - public function getSignerRoles() - { - return $this->container['signer_roles']; - } - - /** - * Sets signer_roles - * - * @param TemplateResponseSignerRole[]|null $signer_roles an array of the designated signer roles that must be specified when sending a SignatureRequest using this Template - * - * @return self - */ - public function setSignerRoles(?array $signer_roles) - { - if (is_null($signer_roles)) { - throw new InvalidArgumentException('non-nullable signer_roles cannot be null'); - } - $this->container['signer_roles'] = $signer_roles; - - return $this; - } - - /** - * Gets cc_roles - * - * @return TemplateResponseCCRole[]|null - */ - public function getCcRoles() - { - return $this->container['cc_roles']; - } - - /** - * Sets cc_roles - * - * @param TemplateResponseCCRole[]|null $cc_roles an array of the designated CC roles that must be specified when sending a SignatureRequest using this Template - * - * @return self - */ - public function setCcRoles(?array $cc_roles) - { - if (is_null($cc_roles)) { - throw new InvalidArgumentException('non-nullable cc_roles cannot be null'); - } - $this->container['cc_roles'] = $cc_roles; - - return $this; - } - /** * Gets custom_fields * diff --git a/sdks/python/docs/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index 5cc6185f8..67cea8322 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -11,14 +11,14 @@ Name | Type | Description | Notes | `is_creator`*_required_ | ```bool``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | | `can_edit`*_required_ | ```bool``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | | `is_locked`*_required_ | ```bool``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```object``` | The metadata attached to the template. | | +| `signer_roles`*_required_ | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles`*_required_ | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `documents`*_required_ | [```List[TemplateResponseDocument]```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `accounts`*_required_ | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | | `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `metadata` | ```object``` | The metadata attached to the template. | | -| `signer_roles` | [```List[TemplateResponseSignerRole]```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```List[TemplateResponseCCRole]```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index e77c7534a..c9a161f67 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -61,6 +61,15 @@ class TemplateResponse(BaseModel): is_locked: StrictBool = Field( description="Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests." ) + metadata: Dict[str, Any] = Field( + description="The metadata attached to the template." + ) + signer_roles: List[TemplateResponseSignerRole] = Field( + description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template." + ) + cc_roles: List[TemplateResponseCCRole] = Field( + description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template." + ) documents: List[TemplateResponseDocument] = Field( description="An array describing each document associated with this Template. Includes form field data for each document." ) @@ -77,17 +86,6 @@ class TemplateResponse(BaseModel): default=None, description="`true` if this template was created using an embedded flow, `false` if it was created on our website.", ) - metadata: Optional[Dict[str, Any]] = Field( - default=None, description="The metadata attached to the template." - ) - signer_roles: Optional[List[TemplateResponseSignerRole]] = Field( - default=None, - description="An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.", - ) - cc_roles: Optional[List[TemplateResponseCCRole]] = Field( - default=None, - description="An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.", - ) custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( default=None, description="Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.", @@ -103,14 +101,14 @@ class TemplateResponse(BaseModel): "is_creator", "can_edit", "is_locked", + "metadata", + "signer_roles", + "cc_roles", "documents", "accounts", "attachments", "updated_at", "is_embedded", - "metadata", - "signer_roles", - "cc_roles", "custom_fields", "named_form_fields", ] @@ -165,6 +163,20 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of each item in signer_roles (list) + _items = [] + if self.signer_roles: + for _item_signer_roles in self.signer_roles: + if _item_signer_roles: + _items.append(_item_signer_roles.to_dict()) + _dict["signer_roles"] = _items + # override the default output from pydantic by calling `to_dict()` of each item in cc_roles (list) + _items = [] + if self.cc_roles: + for _item_cc_roles in self.cc_roles: + if _item_cc_roles: + _items.append(_item_cc_roles.to_dict()) + _dict["cc_roles"] = _items # override the default output from pydantic by calling `to_dict()` of each item in documents (list) _items = [] if self.documents: @@ -186,20 +198,6 @@ def to_dict(self, excluded_fields: Set[str] = None) -> Dict[str, Any]: if _item_attachments: _items.append(_item_attachments.to_dict()) _dict["attachments"] = _items - # override the default output from pydantic by calling `to_dict()` of each item in signer_roles (list) - _items = [] - if self.signer_roles: - for _item_signer_roles in self.signer_roles: - if _item_signer_roles: - _items.append(_item_signer_roles.to_dict()) - _dict["signer_roles"] = _items - # override the default output from pydantic by calling `to_dict()` of each item in cc_roles (list) - _items = [] - if self.cc_roles: - for _item_cc_roles in self.cc_roles: - if _item_cc_roles: - _items.append(_item_cc_roles.to_dict()) - _dict["cc_roles"] = _items # override the default output from pydantic by calling `to_dict()` of each item in custom_fields (list) _items = [] if self.custom_fields: @@ -233,6 +231,23 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "is_creator": obj.get("is_creator"), "can_edit": obj.get("can_edit"), "is_locked": obj.get("is_locked"), + "metadata": obj.get("metadata"), + "signer_roles": ( + [ + TemplateResponseSignerRole.from_dict(_item) + for _item in obj["signer_roles"] + ] + if obj.get("signer_roles") is not None + else None + ), + "cc_roles": ( + [ + TemplateResponseCCRole.from_dict(_item) + for _item in obj["cc_roles"] + ] + if obj.get("cc_roles") is not None + else None + ), "documents": ( [ TemplateResponseDocument.from_dict(_item) @@ -259,23 +274,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: ), "updated_at": obj.get("updated_at"), "is_embedded": obj.get("is_embedded"), - "metadata": obj.get("metadata"), - "signer_roles": ( - [ - TemplateResponseSignerRole.from_dict(_item) - for _item in obj["signer_roles"] - ] - if obj.get("signer_roles") is not None - else None - ), - "cc_roles": ( - [ - TemplateResponseCCRole.from_dict(_item) - for _item in obj["cc_roles"] - ] - if obj.get("cc_roles") is not None - else None - ), "custom_fields": ( [ TemplateResponseDocumentCustomFieldBase.from_dict(_item) @@ -315,14 +313,14 @@ def openapi_types(cls) -> Dict[str, str]: "is_creator": "(bool,)", "can_edit": "(bool,)", "is_locked": "(bool,)", + "metadata": "(object,)", + "signer_roles": "(List[TemplateResponseSignerRole],)", + "cc_roles": "(List[TemplateResponseCCRole],)", "documents": "(List[TemplateResponseDocument],)", "accounts": "(List[TemplateResponseAccount],)", "attachments": "(List[SignatureRequestResponseAttachment],)", "updated_at": "(int,)", "is_embedded": "(bool,)", - "metadata": "(object,)", - "signer_roles": "(List[TemplateResponseSignerRole],)", - "cc_roles": "(List[TemplateResponseCCRole],)", "custom_fields": "(List[TemplateResponseDocumentCustomFieldBase],)", "named_form_fields": "(List[TemplateResponseDocumentFormFieldBase],)", } @@ -330,11 +328,11 @@ def openapi_types(cls) -> Dict[str, str]: @classmethod def openapi_type_is_array(cls, property_name: str) -> bool: return property_name in [ + "signer_roles", + "cc_roles", "documents", "accounts", "attachments", - "signer_roles", - "cc_roles", "custom_fields", "named_form_fields", ] diff --git a/sdks/ruby/docs/TemplateResponse.md b/sdks/ruby/docs/TemplateResponse.md index 4f3bc5e8a..bd236b911 100644 --- a/sdks/ruby/docs/TemplateResponse.md +++ b/sdks/ruby/docs/TemplateResponse.md @@ -12,14 +12,14 @@ Contains information about the templates you and your team have created. | `is_creator`*_required_ | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | | | `can_edit`*_required_ | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | | | `is_locked`*_required_ | ```Boolean``` | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | | +| `metadata`*_required_ | ```Object``` | The metadata attached to the template. | | +| `signer_roles`*_required_ | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | +| `cc_roles`*_required_ | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `documents`*_required_ | [```Array```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | | | `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```Integer``` | Time the template was last updated. | | | `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | -| `metadata` | ```Object``` | The metadata attached to the template. | | -| `signer_roles` | [```Array```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | | -| `cc_roles` | [```Array```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | | | `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_response.rb index 8eb90d3b6..483522795 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response.rb @@ -43,6 +43,18 @@ class TemplateResponse # @return [Boolean] attr_accessor :is_locked + # The metadata attached to the template. + # @return [Object] + attr_accessor :metadata + + # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. + # @return [Array] + attr_accessor :signer_roles + + # An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. + # @return [Array] + attr_accessor :cc_roles + # An array describing each document associated with this Template. Includes form field data for each document. # @return [Array] attr_accessor :documents @@ -63,18 +75,6 @@ class TemplateResponse # @return [Boolean, nil] attr_accessor :is_embedded - # The metadata attached to the template. - # @return [Object] - attr_accessor :metadata - - # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. - # @return [Array] - attr_accessor :signer_roles - - # An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. - # @return [Array] - attr_accessor :cc_roles - # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. # @return [Array, nil] attr_accessor :custom_fields @@ -92,14 +92,14 @@ def self.attribute_map :'is_creator' => :'is_creator', :'can_edit' => :'can_edit', :'is_locked' => :'is_locked', + :'metadata' => :'metadata', + :'signer_roles' => :'signer_roles', + :'cc_roles' => :'cc_roles', :'documents' => :'documents', :'accounts' => :'accounts', :'attachments' => :'attachments', :'updated_at' => :'updated_at', :'is_embedded' => :'is_embedded', - :'metadata' => :'metadata', - :'signer_roles' => :'signer_roles', - :'cc_roles' => :'cc_roles', :'custom_fields' => :'custom_fields', :'named_form_fields' => :'named_form_fields' } @@ -119,14 +119,14 @@ def self.openapi_types :'is_creator' => :'Boolean', :'can_edit' => :'Boolean', :'is_locked' => :'Boolean', + :'metadata' => :'Object', + :'signer_roles' => :'Array', + :'cc_roles' => :'Array', :'documents' => :'Array', :'accounts' => :'Array', :'attachments' => :'Array', :'updated_at' => :'Integer', :'is_embedded' => :'Boolean', - :'metadata' => :'Object', - :'signer_roles' => :'Array', - :'cc_roles' => :'Array', :'custom_fields' => :'Array', :'named_form_fields' => :'Array' } @@ -205,6 +205,22 @@ def initialize(attributes = {}) self.is_locked = attributes[:'is_locked'] end + if attributes.key?(:'metadata') + self.metadata = attributes[:'metadata'] + end + + if attributes.key?(:'signer_roles') + if (value = attributes[:'signer_roles']).is_a?(Array) + self.signer_roles = value + end + end + + if attributes.key?(:'cc_roles') + if (value = attributes[:'cc_roles']).is_a?(Array) + self.cc_roles = value + end + end + if attributes.key?(:'documents') if (value = attributes[:'documents']).is_a?(Array) self.documents = value @@ -231,22 +247,6 @@ def initialize(attributes = {}) self.is_embedded = attributes[:'is_embedded'] end - if attributes.key?(:'metadata') - self.metadata = attributes[:'metadata'] - end - - if attributes.key?(:'signer_roles') - if (value = attributes[:'signer_roles']).is_a?(Array) - self.signer_roles = value - end - end - - if attributes.key?(:'cc_roles') - if (value = attributes[:'cc_roles']).is_a?(Array) - self.cc_roles = value - end - end - if attributes.key?(:'custom_fields') if (value = attributes[:'custom_fields']).is_a?(Array) self.custom_fields = value @@ -288,6 +288,18 @@ def list_invalid_properties invalid_properties.push('invalid value for "is_locked", is_locked cannot be nil.') end + if @metadata.nil? + invalid_properties.push('invalid value for "metadata", metadata cannot be nil.') + end + + if @signer_roles.nil? + invalid_properties.push('invalid value for "signer_roles", signer_roles cannot be nil.') + end + + if @cc_roles.nil? + invalid_properties.push('invalid value for "cc_roles", cc_roles cannot be nil.') + end + if @documents.nil? invalid_properties.push('invalid value for "documents", documents cannot be nil.') end @@ -312,6 +324,9 @@ def valid? return false if @is_creator.nil? return false if @can_edit.nil? return false if @is_locked.nil? + return false if @metadata.nil? + return false if @signer_roles.nil? + return false if @cc_roles.nil? return false if @documents.nil? return false if @accounts.nil? return false if @attachments.nil? @@ -329,14 +344,14 @@ def ==(o) is_creator == o.is_creator && can_edit == o.can_edit && is_locked == o.is_locked && + metadata == o.metadata && + signer_roles == o.signer_roles && + cc_roles == o.cc_roles && documents == o.documents && accounts == o.accounts && attachments == o.attachments && updated_at == o.updated_at && is_embedded == o.is_embedded && - metadata == o.metadata && - signer_roles == o.signer_roles && - cc_roles == o.cc_roles && custom_fields == o.custom_fields && named_form_fields == o.named_form_fields end @@ -350,7 +365,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [template_id, title, message, is_creator, can_edit, is_locked, documents, accounts, attachments, updated_at, is_embedded, metadata, signer_roles, cc_roles, custom_fields, named_form_fields].hash + [template_id, title, message, is_creator, can_edit, is_locked, metadata, signer_roles, cc_roles, documents, accounts, attachments, updated_at, is_embedded, custom_fields, named_form_fields].hash end # Builds the object from hash From 0df4bb863fb469f4e997d95d5a4bd1695cdec994 Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Wed, 16 Oct 2024 12:25:33 -0500 Subject: [PATCH 3/4] Undo bad merge --- openapi-raw.yaml | 40 ++++++ openapi-sdk.yaml | 40 ++++++ openapi.yaml | 40 ++++++ sdks/dotnet/docs/OAuthApi.md | 2 + sdks/dotnet/docs/OAuthTokenRefreshRequest.md | 2 +- .../Model/OAuthTokenRefreshRequest.cs | 54 +++++++- sdks/java-v1/docs/OAuthApi.md | 2 + sdks/java-v1/docs/OAuthTokenRefreshRequest.md | 2 + .../java/com/dropbox/sign/api/OAuthApi.java | 4 + .../sign/model/OAuthTokenRefreshRequest.java | 106 +++++++++++++- sdks/java-v2/docs/OAuthApi.md | 2 + sdks/java-v2/docs/OAuthTokenRefreshRequest.md | 2 + .../java/com/dropbox/sign/api/OAuthApi.java | 5 + .../sign/model/OAuthTokenRefreshRequest.java | 106 +++++++++++++- sdks/node/api/oAuthApi.ts | 22 +++ sdks/node/dist/api.js | 130 +++++++++++------- .../docs/model/OAuthTokenRefreshRequest.md | 2 + sdks/node/model/oAuthTokenRefreshRequest.ts | 18 +++ .../types/model/oAuthTokenRefreshRequest.d.ts | 2 + .../docs/Model/OAuthTokenRefreshRequest.md | 2 + sdks/php/src/Api/OAuthApi.php | 24 ++++ .../src/Model/OAuthTokenRefreshRequest.php | 68 +++++++++ sdks/python/docs/OAuthApi.md | 2 + sdks/python/docs/OAuthTokenRefreshRequest.md | 2 + sdks/python/dropbox_sign/api/o_auth_api.py | 6 + .../models/o_auth_token_refresh_request.py | 21 ++- sdks/ruby/docs/OAuthTokenRefreshRequest.md | 2 + sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb | 28 ++++ .../models/o_auth_token_refresh_request.rb | 30 +++- 29 files changed, 705 insertions(+), 61 deletions(-) diff --git a/openapi-raw.yaml b/openapi-raw.yaml index 827695b87..e0d57e123 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -2233,6 +2233,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2316,6 +2333,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7288,6 +7322,12 @@ components: refresh_token: description: '_t__OAuthTokenRefresh::REFRESH_TOKEN' type: string + client_id: + description: '_t__OAuthTokenRefresh::CLIENT_ID' + type: string + client_secret: + description: '_t__OAuthTokenRefresh::CLIENT_SECRET' + type: string type: object ReportCreateRequest: required: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index f12bdee8f..b96ee3e7e 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -2239,6 +2239,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2322,6 +2339,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7382,6 +7416,12 @@ components: refresh_token: description: 'The token provided when you got the expired access token.' type: string + client_id: + description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string + client_secret: + description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string type: object ReportCreateRequest: required: diff --git a/openapi.yaml b/openapi.yaml index 532f0a843..cda396dce 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -2239,6 +2239,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -2322,6 +2339,23 @@ paths: examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + 4XX: + description: failed_operation + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400_example: + $ref: '#/components/examples/Error400ResponseExample' + 401_example: + $ref: '#/components/examples/Error401ResponseExample' + 402_example: + $ref: '#/components/examples/Error402ResponseExample' + 403_example: + $ref: '#/components/examples/Error403ResponseExample' + 4XX_example: + $ref: '#/components/examples/Error4XXResponseExample' security: [] servers: - @@ -7382,6 +7416,12 @@ components: refresh_token: description: 'The token provided when you got the expired access token.' type: string + client_id: + description: 'The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string + client_secret: + description: 'The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.' + type: string type: object ReportCreateRequest: required: diff --git a/sdks/dotnet/docs/OAuthApi.md b/sdks/dotnet/docs/OAuthApi.md index 5af912344..c80ee2758 100644 --- a/sdks/dotnet/docs/OAuthApi.md +++ b/sdks/dotnet/docs/OAuthApi.md @@ -99,6 +99,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -191,6 +192,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/OAuthTokenRefreshRequest.md b/sdks/dotnet/docs/OAuthTokenRefreshRequest.md index c9866d3bf..5e33e77d9 100644 --- a/sdks/dotnet/docs/OAuthTokenRefreshRequest.md +++ b/sdks/dotnet/docs/OAuthTokenRefreshRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | +**GrantType** | **string** | When refreshing an existing token use `refresh_token`. | [default to "refresh_token"]**RefreshToken** | **string** | The token provided when you got the expired access token. | **ClientId** | **string** | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [optional] **ClientSecret** | **string** | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | [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/OAuthTokenRefreshRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs index dbfb22b5f..934de0d88 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/OAuthTokenRefreshRequest.cs @@ -43,7 +43,9 @@ protected OAuthTokenRefreshRequest() { } /// /// When refreshing an existing token use `refresh_token`. (required) (default to "refresh_token"). /// The token provided when you got the expired access token. (required). - public OAuthTokenRefreshRequest(string grantType = @"refresh_token", string refreshToken = default(string)) + /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.. + /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled.. + public OAuthTokenRefreshRequest(string grantType = @"refresh_token", string refreshToken = default(string), string clientId = default(string), string clientSecret = default(string)) { // to ensure "grantType" is required (not null) @@ -58,6 +60,8 @@ protected OAuthTokenRefreshRequest() { } throw new ArgumentNullException("refreshToken is a required property for OAuthTokenRefreshRequest and cannot be null"); } this.RefreshToken = refreshToken; + this.ClientId = clientId; + this.ClientSecret = clientSecret; } /// @@ -90,6 +94,20 @@ public static OAuthTokenRefreshRequest Init(string jsonData) [DataMember(Name = "refresh_token", IsRequired = true, EmitDefaultValue = true)] public string RefreshToken { get; set; } + /// + /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + /// + /// The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + [DataMember(Name = "client_id", EmitDefaultValue = true)] + public string ClientId { get; set; } + + /// + /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + /// + /// The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + [DataMember(Name = "client_secret", EmitDefaultValue = true)] + public string ClientSecret { get; set; } + /// /// Returns the string presentation of the object /// @@ -100,6 +118,8 @@ public override string ToString() sb.Append("class OAuthTokenRefreshRequest {\n"); sb.Append(" GrantType: ").Append(GrantType).Append("\n"); sb.Append(" RefreshToken: ").Append(RefreshToken).Append("\n"); + sb.Append(" ClientId: ").Append(ClientId).Append("\n"); + sb.Append(" ClientSecret: ").Append(ClientSecret).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -144,6 +164,16 @@ public bool Equals(OAuthTokenRefreshRequest input) this.RefreshToken == input.RefreshToken || (this.RefreshToken != null && this.RefreshToken.Equals(input.RefreshToken)) + ) && + ( + this.ClientId == input.ClientId || + (this.ClientId != null && + this.ClientId.Equals(input.ClientId)) + ) && + ( + this.ClientSecret == input.ClientSecret || + (this.ClientSecret != null && + this.ClientSecret.Equals(input.ClientSecret)) ); } @@ -164,6 +194,14 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.RefreshToken.GetHashCode(); } + if (this.ClientId != null) + { + hashCode = (hashCode * 59) + this.ClientId.GetHashCode(); + } + if (this.ClientSecret != null) + { + hashCode = (hashCode * 59) + this.ClientSecret.GetHashCode(); + } return hashCode; } } @@ -194,6 +232,20 @@ public List GetOpenApiTypes() Type = "string", Value = RefreshToken, }); + types.Add(new OpenApiType() + { + Name = "client_id", + Property = "ClientId", + Type = "string", + Value = ClientId, + }); + types.Add(new OpenApiType() + { + Name = "client_secret", + Property = "ClientSecret", + Type = "string", + Value = ClientSecret, + }); return types; } diff --git a/sdks/java-v1/docs/OAuthApi.md b/sdks/java-v1/docs/OAuthApi.md index 533052ba2..a2eaa2508 100644 --- a/sdks/java-v1/docs/OAuthApi.md +++ b/sdks/java-v1/docs/OAuthApi.md @@ -77,6 +77,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | ## oauthTokenRefresh @@ -144,4 +145,5 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | diff --git a/sdks/java-v1/docs/OAuthTokenRefreshRequest.md b/sdks/java-v1/docs/OAuthTokenRefreshRequest.md index 2b985fa91..f0ce43061 100644 --- a/sdks/java-v1/docs/OAuthTokenRefreshRequest.md +++ b/sdks/java-v1/docs/OAuthTokenRefreshRequest.md @@ -10,6 +10,8 @@ |------------ | ------------- | ------------- | -------------| | `grantType`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | | | `refreshToken`*_required_ | ```String``` | The token provided when you got the expired access token. | | +| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java index f9e6d08f3..db4fbb10c 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -55,6 +55,7 @@ public void setApiClient(ApiClient apiClient) { * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenGenerate( @@ -73,6 +74,7 @@ public OAuthTokenResponse oauthTokenGenerate( * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenGenerateWithHttpInfo( @@ -125,6 +127,7 @@ public ApiResponse oauthTokenGenerateWithHttpInfo( * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest) @@ -145,6 +148,7 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR * * * + * *
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenRefreshWithHttpInfo( diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java index 6aa0a0552..75979827e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java @@ -26,7 +26,9 @@ /** OAuthTokenRefreshRequest */ @JsonPropertyOrder({ OAuthTokenRefreshRequest.JSON_PROPERTY_GRANT_TYPE, - OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN + OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_ID, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_SECRET }) @javax.annotation.Generated( value = "org.openapitools.codegen.languages.JavaClientCodegen", @@ -39,6 +41,12 @@ public class OAuthTokenRefreshRequest { public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; private String refreshToken; + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; + private String clientSecret; + public OAuthTokenRefreshRequest() {} /** @@ -103,6 +111,54 @@ public void setRefreshToken(String refreshToken) { this.refreshToken = refreshToken; } + public OAuthTokenRefreshRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the + * \"Client Credentials Required\" setting is enabled for token refresh; optional if + * disabled. + * + * @return clientId + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getClientId() { + return clientId; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + public OAuthTokenRefreshRequest clientSecret(String clientSecret) { + this.clientSecret = clientSecret; + return this; + } + + /** + * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if + * the \"Client Credentials Required\" setting is enabled for token refresh; optional + * if disabled. + * + * @return clientSecret + */ + @javax.annotation.Nullable @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getClientSecret() { + return clientSecret; + } + + @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientSecret(String clientSecret) { + this.clientSecret = clientSecret; + } + /** Return true if this OAuthTokenRefreshRequest object is equal to o. */ @Override public boolean equals(Object o) { @@ -114,12 +170,14 @@ public boolean equals(Object o) { } OAuthTokenRefreshRequest oauthTokenRefreshRequest = (OAuthTokenRefreshRequest) o; return Objects.equals(this.grantType, oauthTokenRefreshRequest.grantType) - && Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken); + && Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken) + && Objects.equals(this.clientId, oauthTokenRefreshRequest.clientId) + && Objects.equals(this.clientSecret, oauthTokenRefreshRequest.clientSecret); } @Override public int hashCode() { - return Objects.hash(grantType, refreshToken); + return Objects.hash(grantType, refreshToken, clientId, clientSecret); } @Override @@ -128,6 +186,8 @@ public String toString() { sb.append("class OAuthTokenRefreshRequest {\n"); sb.append(" grantType: ").append(toIndentedString(grantType)).append("\n"); sb.append(" refreshToken: ").append(toIndentedString(refreshToken)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -176,6 +236,46 @@ public Map createFormData() throws ApiException { JSON.getDefault().getMapper().writeValueAsString(refreshToken)); } } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) + || clientId.getClass().equals(Integer.class) + || clientId.getClass().equals(String.class) + || clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for (int i = 0; i < getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } else { + map.put( + "client_id", + JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (clientSecret != null) { + if (isFileTypeOrListOfFiles(clientSecret)) { + fileTypeFound = true; + } + + if (clientSecret.getClass().equals(java.io.File.class) + || clientSecret.getClass().equals(Integer.class) + || clientSecret.getClass().equals(String.class) + || clientSecret.getClass().isEnum()) { + map.put("client_secret", clientSecret); + } else if (isListOfFile(clientSecret)) { + for (int i = 0; i < getListSize(clientSecret); i++) { + map.put("client_secret[" + i + "]", getFromList(clientSecret, i)); + } + } else { + map.put( + "client_secret", + JSON.getDefault().getMapper().writeValueAsString(clientSecret)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/java-v2/docs/OAuthApi.md b/sdks/java-v2/docs/OAuthApi.md index 533052ba2..a2eaa2508 100644 --- a/sdks/java-v2/docs/OAuthApi.md +++ b/sdks/java-v2/docs/OAuthApi.md @@ -77,6 +77,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | ## oauthTokenRefresh @@ -144,4 +145,5 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| | **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +| **4XX** | failed_operation | - | diff --git a/sdks/java-v2/docs/OAuthTokenRefreshRequest.md b/sdks/java-v2/docs/OAuthTokenRefreshRequest.md index 2b985fa91..f0ce43061 100644 --- a/sdks/java-v2/docs/OAuthTokenRefreshRequest.md +++ b/sdks/java-v2/docs/OAuthTokenRefreshRequest.md @@ -10,6 +10,8 @@ |------------ | ------------- | ------------- | -------------| | `grantType`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | | | `refreshToken`*_required_ | ```String``` | The token provided when you got the expired access token. | | +| `clientId` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `clientSecret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java index 98b580202..4d881a94e 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -8,6 +8,7 @@ import jakarta.ws.rs.core.GenericType; +import com.dropbox.sign.model.ErrorResponse; import com.dropbox.sign.model.OAuthTokenGenerateRequest; import com.dropbox.sign.model.OAuthTokenRefreshRequest; import com.dropbox.sign.model.OAuthTokenResponse; @@ -58,6 +59,7 @@ public void setApiClient(ApiClient apiClient) { +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthTokenGenerateRequest) throws ApiException { @@ -75,6 +77,7 @@ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthToke +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthTokenGenerateRequest oauthTokenGenerateRequest) throws ApiException { @@ -116,6 +119,7 @@ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthToken +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenRefreshRequest) throws ApiException { @@ -133,6 +137,7 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR +
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
*/ public ApiResponse oauthTokenRefreshWithHttpInfo(OAuthTokenRefreshRequest oauthTokenRefreshRequest) throws ApiException { diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java index 28eb1cdfb..fafe689fc 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java @@ -34,7 +34,9 @@ */ @JsonPropertyOrder({ OAuthTokenRefreshRequest.JSON_PROPERTY_GRANT_TYPE, - OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN + OAuthTokenRefreshRequest.JSON_PROPERTY_REFRESH_TOKEN, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_ID, + OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_SECRET }) @jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") @JsonIgnoreProperties(ignoreUnknown=true) @@ -45,6 +47,12 @@ public class OAuthTokenRefreshRequest { public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; private String refreshToken; + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + private String clientId; + + public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; + private String clientSecret; + public OAuthTokenRefreshRequest() { } @@ -113,6 +121,56 @@ public void setRefreshToken(String refreshToken) { } + public OAuthTokenRefreshRequest clientId(String clientId) { + this.clientId = clientId; + return this; + } + + /** + * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * @return clientId + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(String clientId) { + this.clientId = clientId; + } + + + public OAuthTokenRefreshRequest clientSecret(String clientSecret) { + this.clientSecret = clientSecret; + return this; + } + + /** + * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * @return clientSecret + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientSecret() { + return clientSecret; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientSecret(String clientSecret) { + this.clientSecret = clientSecret; + } + + /** * Return true if this OAuthTokenRefreshRequest object is equal to o. */ @@ -126,12 +184,14 @@ public boolean equals(Object o) { } OAuthTokenRefreshRequest oauthTokenRefreshRequest = (OAuthTokenRefreshRequest) o; return Objects.equals(this.grantType, oauthTokenRefreshRequest.grantType) && - Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken); + Objects.equals(this.refreshToken, oauthTokenRefreshRequest.refreshToken) && + Objects.equals(this.clientId, oauthTokenRefreshRequest.clientId) && + Objects.equals(this.clientSecret, oauthTokenRefreshRequest.clientSecret); } @Override public int hashCode() { - return Objects.hash(grantType, refreshToken); + return Objects.hash(grantType, refreshToken, clientId, clientSecret); } @Override @@ -140,6 +200,8 @@ public String toString() { sb.append("class OAuthTokenRefreshRequest {\n"); sb.append(" grantType: ").append(toIndentedString(grantType)).append("\n"); sb.append(" refreshToken: ").append(toIndentedString(refreshToken)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" clientSecret: ").append(toIndentedString(clientSecret)).append("\n"); sb.append("}"); return sb.toString(); } @@ -186,6 +248,44 @@ public Map createFormData() throws ApiException { map.put("refresh_token", JSON.getDefault().getMapper().writeValueAsString(refreshToken)); } } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (clientSecret != null) { + if (isFileTypeOrListOfFiles(clientSecret)) { + fileTypeFound = true; + } + + if (clientSecret.getClass().equals(java.io.File.class) || + clientSecret.getClass().equals(Integer.class) || + clientSecret.getClass().equals(String.class) || + clientSecret.getClass().isEnum()) { + map.put("client_secret", clientSecret); + } else if (isListOfFile(clientSecret)) { + for(int i = 0; i< getListSize(clientSecret); i++) { + map.put("client_secret[" + i + "]", getFromList(clientSecret, i)); + } + } + else { + map.put("client_secret", JSON.getDefault().getMapper().writeValueAsString(clientSecret)); + } + } } catch (Exception e) { throw new ApiException(e); } diff --git a/sdks/node/api/oAuthApi.ts b/sdks/node/api/oAuthApi.ts index c1b080359..1478d53e0 100644 --- a/sdks/node/api/oAuthApi.ts +++ b/sdks/node/api/oAuthApi.ts @@ -236,6 +236,17 @@ export class OAuthApi { return; } + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + reject(error); } ); @@ -361,6 +372,17 @@ export class OAuthApi { return; } + if ( + handleErrorRangeResponse( + reject, + error.response, + "4XX", + "ErrorResponse" + ) + ) { + return; + } + reject(error); } ); diff --git a/sdks/node/dist/api.js b/sdks/node/dist/api.js index e1b290ca1..27094d35b 100644 --- a/sdks/node/dist/api.js +++ b/sdks/node/dist/api.js @@ -18331,6 +18331,16 @@ OAuthTokenRefreshRequest.attributeTypeMap = [ name: "refreshToken", baseName: "refresh_token", type: "string" + }, + { + name: "clientId", + baseName: "client_id", + type: "string" + }, + { + name: "clientSecret", + baseName: "client_secret", + type: "string" } ]; @@ -27340,6 +27350,14 @@ var OAuthApi = class { )) { return; } + if (handleErrorRangeResponse6( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } reject(error); } ); @@ -27435,6 +27453,14 @@ var OAuthApi = class { )) { return; } + if (handleErrorRangeResponse6( + reject, + error.response, + "4XX", + "ErrorResponse" + )) { + return; + } reject(error); } ); @@ -27468,6 +27494,16 @@ function handleErrorCodeResponse6(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } +function handleErrorRangeResponse6(reject, response, code, returnType) { + let rangeCodeLeft = Number(code[0] + "00"); + let rangeCodeRight = Number(code[0] + "99"); + if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { + const body = ObjectSerializer.deserialize(response.data, returnType); + reject(new HttpError(response, body, response.status)); + return true; + } + return false; +} // api/reportApi.ts var defaultBasePath7 = "https://api.hellosign.com/v3"; @@ -27613,7 +27649,7 @@ var ReportApi = class { )) { return; } - if (handleErrorRangeResponse6( + if (handleErrorRangeResponse7( reject, error.response, "4XX", @@ -27655,7 +27691,7 @@ function handleErrorCodeResponse7(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse6(reject, response, code, returnType) { +function handleErrorRangeResponse7(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -27810,7 +27846,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -27925,7 +27961,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28008,7 +28044,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28122,7 +28158,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28237,7 +28273,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28339,7 +28375,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28435,7 +28471,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28537,7 +28573,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28633,7 +28669,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28746,7 +28782,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28843,7 +28879,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -28966,7 +29002,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29044,7 +29080,7 @@ var SignatureRequestApi = class { reject(error); return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29158,7 +29194,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29273,7 +29309,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29396,7 +29432,7 @@ var SignatureRequestApi = class { )) { return; } - if (handleErrorRangeResponse7( + if (handleErrorRangeResponse8( reject, error.response, "4XX", @@ -29438,7 +29474,7 @@ function handleErrorCodeResponse8(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse7(reject, response, code, returnType) { +function handleErrorRangeResponse8(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -29603,7 +29639,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29713,7 +29749,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29787,7 +29823,7 @@ var TeamApi = class { reject(error); return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29874,7 +29910,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -29968,7 +30004,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30063,7 +30099,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30172,7 +30208,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30286,7 +30322,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30394,7 +30430,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30505,7 +30541,7 @@ var TeamApi = class { )) { return; } - if (handleErrorRangeResponse8( + if (handleErrorRangeResponse9( reject, error.response, "4XX", @@ -30546,7 +30582,7 @@ function handleErrorCodeResponse9(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse8(reject, response, code, returnType) { +function handleErrorRangeResponse9(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -30714,7 +30750,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30829,7 +30865,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -30944,7 +30980,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31027,7 +31063,7 @@ var TemplateApi = class { reject(error); return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31128,7 +31164,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31224,7 +31260,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31326,7 +31362,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31422,7 +31458,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31535,7 +31571,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31658,7 +31694,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31781,7 +31817,7 @@ var TemplateApi = class { )) { return; } - if (handleErrorRangeResponse9( + if (handleErrorRangeResponse10( reject, error.response, "4XX", @@ -31823,7 +31859,7 @@ function handleErrorCodeResponse10(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse9(reject, response, code, returnType) { +function handleErrorRangeResponse10(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { @@ -31983,7 +32019,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32098,7 +32134,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32213,7 +32249,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32336,7 +32372,7 @@ var UnclaimedDraftApi = class { )) { return; } - if (handleErrorRangeResponse10( + if (handleErrorRangeResponse11( reject, error.response, "4XX", @@ -32378,7 +32414,7 @@ function handleErrorCodeResponse11(reject, response, code, returnType) { reject(new HttpError(response, body, response.status)); return true; } -function handleErrorRangeResponse10(reject, response, code, returnType) { +function handleErrorRangeResponse11(reject, response, code, returnType) { let rangeCodeLeft = Number(code[0] + "00"); let rangeCodeRight = Number(code[0] + "99"); if (response.status >= rangeCodeLeft && response.status <= rangeCodeRight) { diff --git a/sdks/node/docs/model/OAuthTokenRefreshRequest.md b/sdks/node/docs/model/OAuthTokenRefreshRequest.md index d5dc06d1b..8a24bdc15 100644 --- a/sdks/node/docs/model/OAuthTokenRefreshRequest.md +++ b/sdks/node/docs/model/OAuthTokenRefreshRequest.md @@ -8,5 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grantType`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refreshToken`*_required_ | ```string``` | The token provided when you got the expired access token. | | +| `clientId` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `clientSecret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/oAuthTokenRefreshRequest.ts b/sdks/node/model/oAuthTokenRefreshRequest.ts index e6c6848b6..2f8971dd5 100644 --- a/sdks/node/model/oAuthTokenRefreshRequest.ts +++ b/sdks/node/model/oAuthTokenRefreshRequest.ts @@ -33,6 +33,14 @@ export class OAuthTokenRefreshRequest { * The token provided when you got the expired access token. */ "refreshToken": string; + /** + * The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + */ + "clientId"?: string; + /** + * The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + */ + "clientSecret"?: string; static discriminator: string | undefined = undefined; @@ -47,6 +55,16 @@ export class OAuthTokenRefreshRequest { baseName: "refresh_token", type: "string", }, + { + name: "clientId", + baseName: "client_id", + type: "string", + }, + { + name: "clientSecret", + baseName: "client_secret", + type: "string", + }, ]; static getAttributeTypeMap(): AttributeTypeMap { diff --git a/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts b/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts index 53211884e..71f3d108f 100644 --- a/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts +++ b/sdks/node/types/model/oAuthTokenRefreshRequest.d.ts @@ -2,6 +2,8 @@ import { AttributeTypeMap } from "./"; export declare class OAuthTokenRefreshRequest { "grantType": string; "refreshToken": string; + "clientId"?: string; + "clientSecret"?: string; static discriminator: string | undefined; static attributeTypeMap: AttributeTypeMap; static getAttributeTypeMap(): AttributeTypeMap; diff --git a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md index c9525386c..9ba09db42 100644 --- a/sdks/php/docs/Model/OAuthTokenRefreshRequest.md +++ b/sdks/php/docs/Model/OAuthTokenRefreshRequest.md @@ -8,5 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grant_type`*_required_ | ```string``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```string``` | The token provided when you got the expired access token. | | +| `client_id` | ```string``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `client_secret` | ```string``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/Api/OAuthApi.php b/sdks/php/src/Api/OAuthApi.php index 6fa77398a..81468626d 100644 --- a/sdks/php/src/Api/OAuthApi.php +++ b/sdks/php/src/Api/OAuthApi.php @@ -211,6 +211,15 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ ); } + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { @@ -269,6 +278,9 @@ public function oauthTokenGenerateWithHttpInfo(Model\OAuthTokenGenerateRequest $ $response->getHeaders(), ]; } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( @@ -582,6 +594,15 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ ); } + $result = $this->handleRangeCodeResponse( + $response, + '4XX', + '\Dropbox\Sign\Model\ErrorResponse' + ); + if ($result) { + return $result; + } + switch ($statusCode) { case 200: if ('\Dropbox\Sign\Model\OAuthTokenResponse' === '\SplFileObject') { @@ -640,6 +661,9 @@ public function oauthTokenRefreshWithHttpInfo(Model\OAuthTokenRefreshRequest $o_ $response->getHeaders(), ]; } catch (ApiException $e) { + if ($this->handleRangeCodeException($e, '4XX', '\Dropbox\Sign\Model\ErrorResponse')) { + throw $e; + } switch ($e->getCode()) { case 200: $data = ObjectSerializer::deserialize( diff --git a/sdks/php/src/Model/OAuthTokenRefreshRequest.php b/sdks/php/src/Model/OAuthTokenRefreshRequest.php index c4c7f93be..11cf05a3b 100644 --- a/sdks/php/src/Model/OAuthTokenRefreshRequest.php +++ b/sdks/php/src/Model/OAuthTokenRefreshRequest.php @@ -59,6 +59,8 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static $openAPITypes = [ 'grant_type' => 'string', 'refresh_token' => 'string', + 'client_id' => 'string', + 'client_secret' => 'string', ]; /** @@ -71,6 +73,8 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static $openAPIFormats = [ 'grant_type' => null, 'refresh_token' => null, + 'client_id' => null, + 'client_secret' => null, ]; /** @@ -81,6 +85,8 @@ class OAuthTokenRefreshRequest implements ModelInterface, ArrayAccess, JsonSeria protected static array $openAPINullables = [ 'grant_type' => false, 'refresh_token' => false, + 'client_id' => false, + 'client_secret' => false, ]; /** @@ -163,6 +169,8 @@ public function isNullableSetToNull(string $property): bool protected static $attributeMap = [ 'grant_type' => 'grant_type', 'refresh_token' => 'refresh_token', + 'client_id' => 'client_id', + 'client_secret' => 'client_secret', ]; /** @@ -173,6 +181,8 @@ public function isNullableSetToNull(string $property): bool protected static $setters = [ 'grant_type' => 'setGrantType', 'refresh_token' => 'setRefreshToken', + 'client_id' => 'setClientId', + 'client_secret' => 'setClientSecret', ]; /** @@ -183,6 +193,8 @@ public function isNullableSetToNull(string $property): bool protected static $getters = [ 'grant_type' => 'getGrantType', 'refresh_token' => 'getRefreshToken', + 'client_id' => 'getClientId', + 'client_secret' => 'getClientSecret', ]; /** @@ -243,6 +255,8 @@ public function __construct(array $data = null) { $this->setIfExists('grant_type', $data ?? [], 'refresh_token'); $this->setIfExists('refresh_token', $data ?? [], null); + $this->setIfExists('client_id', $data ?? [], null); + $this->setIfExists('client_secret', $data ?? [], null); } /** @@ -364,6 +378,60 @@ public function setRefreshToken(string $refresh_token) return $this; } + /** + * Gets client_id + * + * @return string|null + */ + public function getClientId() + { + return $this->container['client_id']; + } + + /** + * Sets client_id + * + * @param string|null $client_id The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * + * @return self + */ + public function setClientId(?string $client_id) + { + if (is_null($client_id)) { + throw new InvalidArgumentException('non-nullable client_id cannot be null'); + } + $this->container['client_id'] = $client_id; + + return $this; + } + + /** + * Gets client_secret + * + * @return string|null + */ + public function getClientSecret() + { + return $this->container['client_secret']; + } + + /** + * Sets client_secret + * + * @param string|null $client_secret The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + * + * @return self + */ + public function setClientSecret(?string $client_secret) + { + if (is_null($client_secret)) { + throw new InvalidArgumentException('non-nullable client_secret cannot be null'); + } + $this->container['client_secret'] = $client_secret; + + return $this; + } + /** * Returns true if offset exists. False otherwise. * diff --git a/sdks/python/docs/OAuthApi.md b/sdks/python/docs/OAuthApi.md index 969109c45..b26775683 100644 --- a/sdks/python/docs/OAuthApi.md +++ b/sdks/python/docs/OAuthApi.md @@ -67,6 +67,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -126,6 +127,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful operation | * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
| +**4XX** | failed_operation | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/sdks/python/docs/OAuthTokenRefreshRequest.md b/sdks/python/docs/OAuthTokenRefreshRequest.md index 9322c48d6..87662c9e1 100644 --- a/sdks/python/docs/OAuthTokenRefreshRequest.md +++ b/sdks/python/docs/OAuthTokenRefreshRequest.md @@ -7,6 +7,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- | `grant_type`*_required_ | ```str``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```str``` | The token provided when you got the expired access token. | | +| `client_id` | ```str``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `client_secret` | ```str``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | [[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/o_auth_api.py b/sdks/python/dropbox_sign/api/o_auth_api.py index d5035a186..bedd1bfff 100644 --- a/sdks/python/dropbox_sign/api/o_auth_api.py +++ b/sdks/python/dropbox_sign/api/o_auth_api.py @@ -93,6 +93,7 @@ def oauth_token_generate( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -157,6 +158,7 @@ def oauth_token_generate_with_http_info( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -221,6 +223,7 @@ def oauth_token_generate_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -366,6 +369,7 @@ def oauth_token_refresh( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -430,6 +434,7 @@ def oauth_token_refresh_with_http_info( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout @@ -494,6 +499,7 @@ def oauth_token_refresh_without_preload_content( _response_types_map: Dict[str, Optional[str]] = { "200": "OAuthTokenResponse", + "4XX": "ErrorResponse", } response_data = self.api_client.call_api( *_param, _request_timeout=_request_timeout 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 09535d939..573036386 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 @@ -19,7 +19,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictStr -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set, Tuple from typing_extensions import Self import io @@ -38,7 +38,20 @@ class OAuthTokenRefreshRequest(BaseModel): refresh_token: StrictStr = Field( description="The token provided when you got the expired access token." ) - __properties: ClassVar[List[str]] = ["grant_type", "refresh_token"] + client_id: Optional[StrictStr] = Field( + default=None, + description='The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.', + ) + client_secret: Optional[StrictStr] = Field( + default=None, + description='The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled.', + ) + __properties: ClassVar[List[str]] = [ + "grant_type", + "refresh_token", + "client_id", + "client_secret", + ] model_config = ConfigDict( populate_by_name=True, @@ -109,6 +122,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: else "refresh_token" ), "refresh_token": obj.get("refresh_token"), + "client_id": obj.get("client_id"), + "client_secret": obj.get("client_secret"), } ) return _obj @@ -128,6 +143,8 @@ def openapi_types(cls) -> Dict[str, str]: return { "grant_type": "(str,)", "refresh_token": "(str,)", + "client_id": "(str,)", + "client_secret": "(str,)", } @classmethod diff --git a/sdks/ruby/docs/OAuthTokenRefreshRequest.md b/sdks/ruby/docs/OAuthTokenRefreshRequest.md index fe729fe82..4bd1757c8 100644 --- a/sdks/ruby/docs/OAuthTokenRefreshRequest.md +++ b/sdks/ruby/docs/OAuthTokenRefreshRequest.md @@ -8,4 +8,6 @@ | ---- | ---- | ----------- | ----- | | `grant_type`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | [default to 'refresh_token'] | | `refresh_token`*_required_ | ```String``` | The token provided when you got the expired access token. | | +| `client_id` | ```String``` | The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | +| `client_secret` | ```String``` | The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the "Client Credentials Required" setting is enabled for token refresh; optional if disabled. | | 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 eb0c67745..6e9d748e8 100644 --- a/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/o_auth_api.rb @@ -108,6 +108,20 @@ def oauth_token_generate_with_http_info(o_auth_token_generate_request, opts = {} e.message end + 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 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end end @@ -203,6 +217,20 @@ def oauth_token_refresh_with_http_info(o_auth_token_refresh_request, opts = {}) e.message end + 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 + body = @api_client.convert_to_type( + JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0], + "Dropbox::Sign::ErrorResponse" + ) + + fail ApiError.new(:code => e.code, + :response_headers => e.response_headers, + :response_body => body), + e.message + end end diff --git a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb index 7628e0b2e..3ac73212e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/o_auth_token_refresh_request.rb @@ -26,11 +26,21 @@ class OAuthTokenRefreshRequest # @return [String] attr_accessor :refresh_token + # The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + # @return [String] + attr_accessor :client_id + + # The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the \"Client Credentials Required\" setting is enabled for token refresh; optional if disabled. + # @return [String] + attr_accessor :client_secret + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'grant_type' => :'grant_type', - :'refresh_token' => :'refresh_token' + :'refresh_token' => :'refresh_token', + :'client_id' => :'client_id', + :'client_secret' => :'client_secret' } end @@ -43,7 +53,9 @@ def self.acceptable_attributes def self.openapi_types { :'grant_type' => :'String', - :'refresh_token' => :'String' + :'refresh_token' => :'String', + :'client_id' => :'String', + :'client_secret' => :'String' } end @@ -102,6 +114,14 @@ def initialize(attributes = {}) if attributes.key?(:'refresh_token') self.refresh_token = attributes[:'refresh_token'] end + + if attributes.key?(:'client_id') + self.client_id = attributes[:'client_id'] + end + + if attributes.key?(:'client_secret') + self.client_secret = attributes[:'client_secret'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -133,7 +153,9 @@ def ==(o) return true if self.equal?(o) self.class == o.class && grant_type == o.grant_type && - refresh_token == o.refresh_token + refresh_token == o.refresh_token && + client_id == o.client_id && + client_secret == o.client_secret end # @see the `==` method @@ -145,7 +167,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [grant_type, refresh_token].hash + [grant_type, refresh_token, client_id, client_secret].hash end # Builds the object from hash From 3538c257a5ba9f3c6592f0976bc577ce1bcbd793 Mon Sep 17 00:00:00 2001 From: Juan Treminio Date: Thu, 17 Oct 2024 09:39:43 -0500 Subject: [PATCH 4/4] Updating documentation for template.is_embedded --- openapi-sdk.yaml | 2 +- openapi.yaml | 2 +- sdks/dotnet/docs/TemplateResponse.md | 2 +- sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs | 6 +++--- sdks/java-v1/docs/TemplateResponse.md | 2 +- .../main/java/com/dropbox/sign/model/TemplateResponse.java | 3 ++- sdks/java-v2/docs/TemplateResponse.md | 2 +- .../main/java/com/dropbox/sign/model/TemplateResponse.java | 2 +- sdks/node/docs/model/TemplateResponse.md | 2 +- sdks/node/model/templateResponse.ts | 2 +- sdks/php/docs/Model/TemplateResponse.md | 2 +- sdks/php/src/Model/TemplateResponse.php | 2 +- sdks/python/docs/TemplateResponse.md | 2 +- sdks/python/dropbox_sign/models/template_response.py | 2 +- sdks/ruby/docs/TemplateResponse.md | 2 +- sdks/ruby/lib/dropbox-sign/models/template_response.rb | 2 +- translations/en.yaml | 2 +- 17 files changed, 20 insertions(+), 19 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index b96ee3e7e..f24937c67 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -11317,7 +11317,7 @@ components: description: 'Time the template was last updated.' type: integer is_embedded: - description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.' + description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' type: boolean nullable: true is_creator: diff --git a/openapi.yaml b/openapi.yaml index cda396dce..56be94ebe 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -11295,7 +11295,7 @@ components: description: 'Time the template was last updated.' type: integer is_embedded: - description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.' + description: '`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.' type: boolean nullable: true is_creator: diff --git a/sdks/dotnet/docs/TemplateResponse.md b/sdks/dotnet/docs/TemplateResponse.md index d11fa6417..5e8b837b9 100644 --- a/sdks/dotnet/docs/TemplateResponse.md +++ b/sdks/dotnet/docs/TemplateResponse.md @@ -5,7 +5,7 @@ Contains information about the templates you and your team have created. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Metadata** | **Object** | The metadata attached to the template. | **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] +**TemplateId** | **string** | The id of the Template. | **Title** | **string** | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **Message** | **string** | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | **IsCreator** | **bool** | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | **CanEdit** | **bool** | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | **IsLocked** | **bool** | Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. | **Metadata** | **Object** | The metadata attached to the template. | **SignerRoles** | [**List<TemplateResponseSignerRole>**](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | **CcRoles** | [**List<TemplateResponseCCRole>**](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | **Documents** | [**List<TemplateResponseDocument>**](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | **Accounts** | [**List<TemplateResponseAccount>**](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | **Attachments** | [**List<SignatureRequestResponseAttachment>**](SignatureRequestResponseAttachment.md) | Signer attachments. | **UpdatedAt** | **int** | Time the template was last updated. | [optional] **IsEmbedded** | **bool?** | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | [optional] **CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] **NamedFormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | [optional] [[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/TemplateResponse.cs b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs index f9385281b..9a96d947e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/TemplateResponse.cs @@ -45,7 +45,7 @@ protected TemplateResponse() { } /// The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). /// The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. (required). /// Time the template was last updated.. - /// `true` if this template was created using an embedded flow, `false` if it was created on our website.. + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.. /// `true` if you are the owner of this template, `false` if it's been shared with you by a team member. (required). /// Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). (required). /// Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. (required). @@ -231,9 +231,9 @@ public static TemplateResponse Init(string jsonData) public int UpdatedAt { get; set; } /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. /// - /// `true` if this template was created using an embedded flow, `false` if it was created on our website. + /// `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. [DataMember(Name = "is_embedded", EmitDefaultValue = true)] public bool? IsEmbedded { get; set; } diff --git a/sdks/java-v1/docs/TemplateResponse.md b/sdks/java-v1/docs/TemplateResponse.md index 33bace8ba..87d844276 100644 --- a/sdks/java-v1/docs/TemplateResponse.md +++ b/sdks/java-v1/docs/TemplateResponse.md @@ -21,7 +21,7 @@ Contains information about the templates you and your team have created. | `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | -| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | +| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 4f5ecd488..59f31e8af 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -468,7 +468,8 @@ public TemplateResponse isEmbedded(Boolean isEmbedded) { /** * `true` if this template was created using an embedded flow, `false` if it - * was created on our website. + * was created on our website. Will be `null` when you are not the creator of the + * Template. * * @return isEmbedded */ diff --git a/sdks/java-v2/docs/TemplateResponse.md b/sdks/java-v2/docs/TemplateResponse.md index 33bace8ba..87d844276 100644 --- a/sdks/java-v2/docs/TemplateResponse.md +++ b/sdks/java-v2/docs/TemplateResponse.md @@ -21,7 +21,7 @@ Contains information about the templates you and your team have created. | `accounts`*_required_ | [```List```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```List```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```Integer``` | Time the template was last updated. | | -| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | +| `isEmbedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `customFields` | [```List```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```List```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java index 8d6a81f44..7f664e0d1 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -501,7 +501,7 @@ public TemplateResponse isEmbedded(Boolean isEmbedded) { } /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. + * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. * @return isEmbedded */ @jakarta.annotation.Nullable diff --git a/sdks/node/docs/model/TemplateResponse.md b/sdks/node/docs/model/TemplateResponse.md index 30d0e258e..868e86155 100644 --- a/sdks/node/docs/model/TemplateResponse.md +++ b/sdks/node/docs/model/TemplateResponse.md @@ -19,7 +19,7 @@ Name | Type | Description | Notes | `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updatedAt` | ```number``` | Time the template was last updated. | | -| `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | +| `isEmbedded` | ```boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `customFields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `namedFormFields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/node/model/templateResponse.ts b/sdks/node/model/templateResponse.ts index 383a1d3bd..c115a359c 100644 --- a/sdks/node/model/templateResponse.ts +++ b/sdks/node/model/templateResponse.ts @@ -88,7 +88,7 @@ export class TemplateResponse { */ "updatedAt"?: number; /** - * `true` if this template was created using an embedded flow, `false` if it was created on our website. + * `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. */ "isEmbedded"?: boolean | null; /** diff --git a/sdks/php/docs/Model/TemplateResponse.md b/sdks/php/docs/Model/TemplateResponse.md index 030cdc0e1..69ea1cc2b 100644 --- a/sdks/php/docs/Model/TemplateResponse.md +++ b/sdks/php/docs/Model/TemplateResponse.md @@ -19,7 +19,7 @@ Name | Type | Description | Notes | `accounts`*_required_ | [```\Dropbox\Sign\Model\TemplateResponseAccount[]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```\Dropbox\Sign\Model\SignatureRequestResponseAttachment[]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | -| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | +| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `custom_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentCustomFieldBase[]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```\Dropbox\Sign\Model\TemplateResponseDocumentFormFieldBase[]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/php/src/Model/TemplateResponse.php b/sdks/php/src/Model/TemplateResponse.php index 9c413ccc2..7116ea2a7 100644 --- a/sdks/php/src/Model/TemplateResponse.php +++ b/sdks/php/src/Model/TemplateResponse.php @@ -803,7 +803,7 @@ public function getIsEmbedded() /** * Sets is_embedded * - * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website + * @param bool|null $is_embedded `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. * * @return self */ diff --git a/sdks/python/docs/TemplateResponse.md b/sdks/python/docs/TemplateResponse.md index 67cea8322..c86b24d1f 100644 --- a/sdks/python/docs/TemplateResponse.md +++ b/sdks/python/docs/TemplateResponse.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes | `accounts`*_required_ | [```List[TemplateResponseAccount]```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```List[SignatureRequestResponseAttachment]```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```int``` | Time the template was last updated. | | -| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | +| `is_embedded` | ```bool``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `custom_fields` | [```List[TemplateResponseDocumentCustomFieldBase]```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```List[TemplateResponseDocumentFormFieldBase]```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/python/dropbox_sign/models/template_response.py b/sdks/python/dropbox_sign/models/template_response.py index c9a161f67..7b55f5e58 100644 --- a/sdks/python/dropbox_sign/models/template_response.py +++ b/sdks/python/dropbox_sign/models/template_response.py @@ -84,7 +84,7 @@ class TemplateResponse(BaseModel): ) is_embedded: Optional[StrictBool] = Field( default=None, - description="`true` if this template was created using an embedded flow, `false` if it was created on our website.", + description="`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.", ) custom_fields: Optional[List[TemplateResponseDocumentCustomFieldBase]] = Field( default=None, diff --git a/sdks/ruby/docs/TemplateResponse.md b/sdks/ruby/docs/TemplateResponse.md index bd236b911..0d850ce62 100644 --- a/sdks/ruby/docs/TemplateResponse.md +++ b/sdks/ruby/docs/TemplateResponse.md @@ -19,7 +19,7 @@ Contains information about the templates you and your team have created. | `accounts`*_required_ | [```Array```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | | | `attachments`*_required_ | [```Array```](SignatureRequestResponseAttachment.md) | Signer attachments. | | | `updated_at` | ```Integer``` | Time the template was last updated. | | -| `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | | +| `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. | | | `custom_fields` | [```Array```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | | `named_form_fields` | [```Array```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | | diff --git a/sdks/ruby/lib/dropbox-sign/models/template_response.rb b/sdks/ruby/lib/dropbox-sign/models/template_response.rb index 483522795..e070bc7a7 100644 --- a/sdks/ruby/lib/dropbox-sign/models/template_response.rb +++ b/sdks/ruby/lib/dropbox-sign/models/template_response.rb @@ -71,7 +71,7 @@ class TemplateResponse # @return [Integer] attr_accessor :updated_at - # `true` if this template was created using an embedded flow, `false` if it was created on our website. + # `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template. # @return [Boolean, nil] attr_accessor :is_embedded diff --git a/translations/en.yaml b/translations/en.yaml index 74340f9bb..a2b4a367c 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -1449,7 +1449,7 @@ "TemplateResponse::TEMPLATE_ID": The id of the Template. "TemplateResponse::CAN_EDIT": Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). "TemplateResponse::IS_CREATOR": "`true` if you are the owner of this template, `false` if it's been shared with you by a team member." -"TemplateResponse::IS_EMBEDDED": "`true` if this template was created using an embedded flow, `false` if it was created on our website." +"TemplateResponse::IS_EMBEDDED": "`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template." "TemplateResponse::IS_LOCKED": |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`.