dropbox-sign 1.0.0.pre.beta2301
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +10 -0
- data/Gemfile.lock +78 -0
- data/LICENSE +21 -0
- data/README.md +333 -0
- data/Rakefile +10 -0
- data/bin/generate-examples.php +269 -0
- data/bin/php +16 -0
- data/bin/replace +11 -0
- data/bin/ruby +16 -0
- data/bin/scan_for +32 -0
- data/composer.json +10 -0
- data/composer.lock +246 -0
- data/docs/AccountApi.md +301 -0
- data/docs/AccountCreateRequest.md +13 -0
- data/docs/AccountCreateResponse.md +12 -0
- data/docs/AccountGetResponse.md +11 -0
- data/docs/AccountResponse.md +19 -0
- data/docs/AccountResponseQuotas.md +14 -0
- data/docs/AccountUpdateRequest.md +12 -0
- data/docs/AccountVerifyRequest.md +10 -0
- data/docs/AccountVerifyResponse.md +11 -0
- data/docs/AccountVerifyResponseAccount.md +10 -0
- data/docs/ApiAppApi.md +402 -0
- data/docs/ApiAppCreateRequest.md +16 -0
- data/docs/ApiAppGetResponse.md +11 -0
- data/docs/ApiAppListResponse.md +12 -0
- data/docs/ApiAppResponse.md +19 -0
- data/docs/ApiAppResponseOAuth.md +13 -0
- data/docs/ApiAppResponseOptions.md +10 -0
- data/docs/ApiAppResponseOwnerAccount.md +11 -0
- data/docs/ApiAppResponseWhiteLabelingOptions.md +23 -0
- data/docs/ApiAppUpdateRequest.md +16 -0
- data/docs/BulkSendJobApi.md +155 -0
- data/docs/BulkSendJobGetResponse.md +13 -0
- data/docs/BulkSendJobGetResponseSignatureRequests.md +33 -0
- data/docs/BulkSendJobListResponse.md +12 -0
- data/docs/BulkSendJobResponse.md +13 -0
- data/docs/BulkSendJobSendResponse.md +11 -0
- data/docs/EmbeddedApi.md +158 -0
- data/docs/EmbeddedEditUrlRequest.md +19 -0
- data/docs/EmbeddedEditUrlResponse.md +11 -0
- data/docs/EmbeddedEditUrlResponseEmbedded.md +11 -0
- data/docs/EmbeddedSignUrlResponse.md +11 -0
- data/docs/EmbeddedSignUrlResponseEmbedded.md +11 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorResponseError.md +12 -0
- data/docs/EventCallbackRequest.md +13 -0
- data/docs/EventCallbackRequestEvent.md +13 -0
- data/docs/EventCallbackRequestEventMetadata.md +13 -0
- data/docs/FileResponse.md +11 -0
- data/docs/FileResponseDataUri.md +10 -0
- data/docs/ListInfoResponse.md +13 -0
- data/docs/OAuthApi.md +158 -0
- data/docs/OAuthTokenGenerateRequest.md +14 -0
- data/docs/OAuthTokenRefreshRequest.md +11 -0
- data/docs/OAuthTokenResponse.md +14 -0
- data/docs/ReportApi.md +83 -0
- data/docs/ReportCreateRequest.md +12 -0
- data/docs/ReportCreateResponse.md +11 -0
- data/docs/ReportResponse.md +13 -0
- data/docs/SignatureRequestApi.md +1377 -0
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +22 -0
- data/docs/SignatureRequestCreateEmbeddedRequest.md +33 -0
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +24 -0
- data/docs/SignatureRequestGetResponse.md +11 -0
- data/docs/SignatureRequestListResponse.md +12 -0
- data/docs/SignatureRequestRemindRequest.md +11 -0
- data/docs/SignatureRequestResponse.md +32 -0
- data/docs/SignatureRequestResponseAttachment.md +15 -0
- data/docs/SignatureRequestResponseCustomFieldBase.md +17 -0
- data/docs/SignatureRequestResponseCustomFieldCheckbox.md +11 -0
- data/docs/SignatureRequestResponseCustomFieldText.md +11 -0
- data/docs/SignatureRequestResponseCustomFieldTypeEnum.md +9 -0
- data/docs/SignatureRequestResponseDataBase.md +14 -0
- data/docs/SignatureRequestResponseDataTypeEnum.md +9 -0
- data/docs/SignatureRequestResponseDataValueCheckbox.md +11 -0
- data/docs/SignatureRequestResponseDataValueCheckboxMerge.md +11 -0
- data/docs/SignatureRequestResponseDataValueDateSigned.md +11 -0
- data/docs/SignatureRequestResponseDataValueDropdown.md +11 -0
- data/docs/SignatureRequestResponseDataValueInitials.md +11 -0
- data/docs/SignatureRequestResponseDataValueRadio.md +11 -0
- data/docs/SignatureRequestResponseDataValueSignature.md +11 -0
- data/docs/SignatureRequestResponseDataValueText.md +11 -0
- data/docs/SignatureRequestResponseDataValueTextMerge.md +11 -0
- data/docs/SignatureRequestResponseSignatures.md +28 -0
- data/docs/SignatureRequestSendRequest.md +34 -0
- data/docs/SignatureRequestSendWithTemplateRequest.md +25 -0
- data/docs/SignatureRequestUpdateRequest.md +13 -0
- data/docs/SubAttachment.md +13 -0
- data/docs/SubBulkSignerList.md +11 -0
- data/docs/SubBulkSignerListCustomField.md +11 -0
- data/docs/SubCC.md +11 -0
- data/docs/SubCustomField.md +17 -0
- data/docs/SubEditorOptions.md +11 -0
- data/docs/SubFieldOptions.md +10 -0
- data/docs/SubFormFieldGroup.md +12 -0
- data/docs/SubFormFieldRule.md +13 -0
- data/docs/SubFormFieldRuleAction.md +13 -0
- data/docs/SubFormFieldRuleTrigger.md +13 -0
- data/docs/SubFormFieldsPerDocumentBase.md +33 -0
- data/docs/SubFormFieldsPerDocumentCheckbox.md +12 -0
- data/docs/SubFormFieldsPerDocumentCheckboxMerge.md +10 -0
- data/docs/SubFormFieldsPerDocumentDateSigned.md +10 -0
- data/docs/SubFormFieldsPerDocumentDropdown.md +12 -0
- data/docs/SubFormFieldsPerDocumentHyperlink.md +12 -0
- data/docs/SubFormFieldsPerDocumentInitials.md +10 -0
- data/docs/SubFormFieldsPerDocumentRadio.md +12 -0
- data/docs/SubFormFieldsPerDocumentSignature.md +10 -0
- data/docs/SubFormFieldsPerDocumentText.md +17 -0
- data/docs/SubFormFieldsPerDocumentTextMerge.md +10 -0
- data/docs/SubFormFieldsPerDocumentTypeEnum.md +9 -0
- data/docs/SubMergeField.md +11 -0
- data/docs/SubOAuth.md +11 -0
- data/docs/SubOptions.md +10 -0
- data/docs/SubSignatureRequestGroupedSigners.md +12 -0
- data/docs/SubSignatureRequestSigner.md +15 -0
- data/docs/SubSignatureRequestTemplateSigner.md +15 -0
- data/docs/SubSigningOptions.md +16 -0
- data/docs/SubTeamResponse.md +11 -0
- data/docs/SubTemplateRole.md +11 -0
- data/docs/SubUnclaimedDraftSigner.md +12 -0
- data/docs/SubUnclaimedDraftTemplateSigner.md +12 -0
- data/docs/SubWhiteLabelingOptions.md +26 -0
- data/docs/TeamAddMemberRequest.md +12 -0
- data/docs/TeamApi.md +737 -0
- data/docs/TeamCreateRequest.md +10 -0
- data/docs/TeamGetInfoResponse.md +11 -0
- data/docs/TeamGetResponse.md +11 -0
- data/docs/TeamInfoResponse.md +14 -0
- data/docs/TeamInviteResponse.md +15 -0
- data/docs/TeamInvitesResponse.md +11 -0
- data/docs/TeamMemberResponse.md +12 -0
- data/docs/TeamMembersResponse.md +12 -0
- data/docs/TeamParentResponse.md +11 -0
- data/docs/TeamRemoveMemberRequest.md +14 -0
- data/docs/TeamResponse.md +12 -0
- data/docs/TeamSubTeamsResponse.md +12 -0
- data/docs/TeamUpdateRequest.md +10 -0
- data/docs/TemplateAddUserRequest.md +12 -0
- data/docs/TemplateApi.md +782 -0
- data/docs/TemplateCreateEmbeddedDraftRequest.md +34 -0
- data/docs/TemplateCreateEmbeddedDraftResponse.md +11 -0
- data/docs/TemplateCreateEmbeddedDraftResponseTemplate.md +13 -0
- data/docs/TemplateEditResponse.md +10 -0
- data/docs/TemplateGetResponse.md +11 -0
- data/docs/TemplateListResponse.md +12 -0
- data/docs/TemplateRemoveUserRequest.md +11 -0
- data/docs/TemplateResponse.md +24 -0
- data/docs/TemplateResponseAccount.md +15 -0
- data/docs/TemplateResponseAccountQuota.md +13 -0
- data/docs/TemplateResponseCCRole.md +10 -0
- data/docs/TemplateResponseCustomField.md +22 -0
- data/docs/TemplateResponseDocument.md +15 -0
- data/docs/TemplateResponseDocumentCustomField.md +25 -0
- data/docs/TemplateResponseDocumentFieldGroup.md +11 -0
- data/docs/TemplateResponseDocumentFormField.md +23 -0
- data/docs/TemplateResponseDocumentStaticField.md +19 -0
- data/docs/TemplateResponseFieldAvgTextLength.md +11 -0
- data/docs/TemplateResponseNamedFormField.md +23 -0
- data/docs/TemplateResponseSignerRole.md +11 -0
- data/docs/TemplateUpdateFilesRequest.md +15 -0
- data/docs/TemplateUpdateFilesResponse.md +10 -0
- data/docs/TemplateUpdateFilesResponseTemplate.md +11 -0
- data/docs/UnclaimedDraftApi.md +359 -0
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +45 -0
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +38 -0
- data/docs/UnclaimedDraftCreateRequest.md +33 -0
- data/docs/UnclaimedDraftCreateResponse.md +11 -0
- data/docs/UnclaimedDraftEditAndResendRequest.md +17 -0
- data/docs/UnclaimedDraftResponse.md +15 -0
- data/docs/WarningResponse.md +11 -0
- data/dropbox-sign.gemspec +38 -0
- data/examples/AccountCreate.rb +21 -0
- data/examples/AccountGet.rb +18 -0
- data/examples/AccountUpdate.rb +21 -0
- data/examples/AccountVerify.rb +21 -0
- data/examples/ApiAppCreate.rb +35 -0
- data/examples/ApiAppDelete.rb +20 -0
- data/examples/ApiAppGet.rb +20 -0
- data/examples/ApiAppList.rb +21 -0
- data/examples/ApiAppUpdate.rb +32 -0
- data/examples/BulkSendJobGet.rb +20 -0
- data/examples/BulkSendJobList.rb +21 -0
- data/examples/EmbeddedEditUrl.rb +24 -0
- data/examples/EmbeddedSignUrl.rb +20 -0
- data/examples/EventCallback.rb +32 -0
- data/examples/OauthTokenGenerate.rb +24 -0
- data/examples/OauthTokenRefresh.rb +21 -0
- data/examples/ReportCreate.rb +23 -0
- data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +59 -0
- data/examples/SignatureRequestBulkSendWithTemplate.rb +58 -0
- data/examples/SignatureRequestCancel.rb +20 -0
- data/examples/SignatureRequestCreateEmbedded.rb +46 -0
- data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +39 -0
- data/examples/SignatureRequestFiles.rb +20 -0
- data/examples/SignatureRequestFilesAsDataUri.rb +20 -0
- data/examples/SignatureRequestFilesAsFileUrl.rb +20 -0
- data/examples/SignatureRequestGet.rb +20 -0
- data/examples/SignatureRequestList.rb +21 -0
- data/examples/SignatureRequestReleaseHold.rb +20 -0
- data/examples/SignatureRequestRemind.rb +23 -0
- data/examples/SignatureRequestRemove.rb +20 -0
- data/examples/SignatureRequestSend.rb +56 -0
- data/examples/SignatureRequestSendWithTemplate.rb +50 -0
- data/examples/SignatureRequestUpdate.rb +24 -0
- data/examples/TeamAddMember.rb +21 -0
- data/examples/TeamCreate.rb +21 -0
- data/examples/TeamDelete.rb +18 -0
- data/examples/TeamGet.rb +18 -0
- data/examples/TeamInfo.rb +18 -0
- data/examples/TeamInvites.rb +20 -0
- data/examples/TeamMembers.rb +20 -0
- data/examples/TeamRemoveMember.rb +22 -0
- data/examples/TeamSubTeams.rb +20 -0
- data/examples/TeamUpdate.rb +21 -0
- data/examples/TemplateAddUser.rb +23 -0
- data/examples/TemplateCreateEmbeddedDraft.rb +49 -0
- data/examples/TemplateDelete.rb +20 -0
- data/examples/TemplateFiles.rb +20 -0
- data/examples/TemplateFilesAsDataUri.rb +20 -0
- data/examples/TemplateFilesAsFileUrl.rb +20 -0
- data/examples/TemplateGet.rb +20 -0
- data/examples/TemplateList.rb +20 -0
- data/examples/TemplateRemoveUser.rb +23 -0
- data/examples/TemplateUpdateFiles.rb +23 -0
- data/examples/UnclaimedDraftCreate.rb +56 -0
- data/examples/UnclaimedDraftCreateEmbedded.rb +24 -0
- data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +35 -0
- data/examples/UnclaimedDraftEditAndResend.rb +24 -0
- data/lib/dropbox-sign/api/account_api.rb +446 -0
- data/lib/dropbox-sign/api/api_app_api.rb +504 -0
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +213 -0
- data/lib/dropbox-sign/api/embedded_api.rb +234 -0
- data/lib/dropbox-sign/api/o_auth_api.rb +215 -0
- data/lib/dropbox-sign/api/report_api.rb +134 -0
- data/lib/dropbox-sign/api/signature_request_api.rb +1620 -0
- data/lib/dropbox-sign/api/team_api.rb +1011 -0
- data/lib/dropbox-sign/api/template_api.rb +1037 -0
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +467 -0
- data/lib/dropbox-sign/api_client.rb +417 -0
- data/lib/dropbox-sign/api_error.rb +60 -0
- data/lib/dropbox-sign/configuration.rb +303 -0
- data/lib/dropbox-sign/event_callback_helper.rb +54 -0
- data/lib/dropbox-sign/models/account_create_request.rb +285 -0
- data/lib/dropbox-sign/models/account_create_response.rb +270 -0
- data/lib/dropbox-sign/models/account_get_response.rb +261 -0
- data/lib/dropbox-sign/models/account_response.rb +343 -0
- data/lib/dropbox-sign/models/account_response_quotas.rb +296 -0
- data/lib/dropbox-sign/models/account_update_request.rb +271 -0
- data/lib/dropbox-sign/models/account_verify_request.rb +255 -0
- data/lib/dropbox-sign/models/account_verify_response.rb +261 -0
- data/lib/dropbox-sign/models/account_verify_response_account.rb +250 -0
- data/lib/dropbox-sign/models/api_app_create_request.rb +347 -0
- data/lib/dropbox-sign/models/api_app_get_response.rb +261 -0
- data/lib/dropbox-sign/models/api_app_list_response.rb +273 -0
- data/lib/dropbox-sign/models/api_app_response.rb +343 -0
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +283 -0
- data/lib/dropbox-sign/models/api_app_response_options.rb +251 -0
- data/lib/dropbox-sign/models/api_app_response_owner_account.rb +261 -0
- data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +367 -0
- data/lib/dropbox-sign/models/api_app_update_request.rb +324 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +282 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +503 -0
- data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +273 -0
- data/lib/dropbox-sign/models/bulk_send_job_response.rb +282 -0
- data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +357 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +261 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response.rb +261 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +261 -0
- data/lib/dropbox-sign/models/error_response.rb +254 -0
- data/lib/dropbox-sign/models/error_response_error.rb +281 -0
- data/lib/dropbox-sign/models/event_callback_request.rb +281 -0
- data/lib/dropbox-sign/models/event_callback_request_event.rb +334 -0
- data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +285 -0
- data/lib/dropbox-sign/models/file_response.rb +260 -0
- data/lib/dropbox-sign/models/file_response_data_uri.rb +250 -0
- data/lib/dropbox-sign/models/list_info_response.rb +282 -0
- data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +317 -0
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +272 -0
- data/lib/dropbox-sign/models/o_auth_token_response.rb +287 -0
- data/lib/dropbox-sign/models/report_create_request.rb +319 -0
- data/lib/dropbox-sign/models/report_create_response.rb +261 -0
- data/lib/dropbox-sign/models/report_response.rb +305 -0
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +445 -0
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +440 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +569 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +475 -0
- data/lib/dropbox-sign/models/signature_request_get_response.rb +261 -0
- data/lib/dropbox-sign/models/signature_request_list_response.rb +273 -0
- data/lib/dropbox-sign/models/signature_request_remind_request.rb +265 -0
- data/lib/dropbox-sign/models/signature_request_response.rb +494 -0
- data/lib/dropbox-sign/models/signature_request_response_attachment.rb +323 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +316 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +272 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +272 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +40 -0
- data/lib/dropbox-sign/models/signature_request_response_data_base.rb +326 -0
- data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +47 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +266 -0
- data/lib/dropbox-sign/models/signature_request_response_signatures.rb +446 -0
- data/lib/dropbox-sign/models/signature_request_send_request.rb +574 -0
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +480 -0
- data/lib/dropbox-sign/models/signature_request_update_request.rb +286 -0
- data/lib/dropbox-sign/models/sub_attachment.rb +292 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +264 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +270 -0
- data/lib/dropbox-sign/models/sub_cc.rb +270 -0
- data/lib/dropbox-sign/models/sub_custom_field.rb +288 -0
- data/lib/dropbox-sign/models/sub_editor_options.rb +265 -0
- data/lib/dropbox-sign/models/sub_field_options.rb +290 -0
- data/lib/dropbox-sign/models/sub_form_field_group.rb +285 -0
- data/lib/dropbox-sign/models/sub_form_field_rule.rb +353 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +323 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +326 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +435 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +287 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +308 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +292 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +292 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +364 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +262 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +48 -0
- data/lib/dropbox-sign/models/sub_merge_field.rb +304 -0
- data/lib/dropbox-sign/models/sub_o_auth.rb +285 -0
- data/lib/dropbox-sign/models/sub_options.rb +253 -0
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +283 -0
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +369 -0
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +373 -0
- data/lib/dropbox-sign/models/sub_signing_options.rb +338 -0
- data/lib/dropbox-sign/models/sub_team_response.rb +260 -0
- data/lib/dropbox-sign/models/sub_template_role.rb +261 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +281 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +285 -0
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +439 -0
- data/lib/dropbox-sign/models/team_add_member_request.rb +304 -0
- data/lib/dropbox-sign/models/team_create_request.rb +252 -0
- data/lib/dropbox-sign/models/team_get_info_response.rb +261 -0
- data/lib/dropbox-sign/models/team_get_response.rb +261 -0
- data/lib/dropbox-sign/models/team_info_response.rb +290 -0
- data/lib/dropbox-sign/models/team_invite_response.rb +300 -0
- data/lib/dropbox-sign/models/team_invites_response.rb +263 -0
- data/lib/dropbox-sign/models/team_member_response.rb +270 -0
- data/lib/dropbox-sign/models/team_members_response.rb +272 -0
- data/lib/dropbox-sign/models/team_parent_response.rb +261 -0
- data/lib/dropbox-sign/models/team_remove_member_request.rb +324 -0
- data/lib/dropbox-sign/models/team_response.rb +274 -0
- data/lib/dropbox-sign/models/team_sub_teams_response.rb +272 -0
- data/lib/dropbox-sign/models/team_update_request.rb +250 -0
- data/lib/dropbox-sign/models/template_add_user_request.rb +272 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +567 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +261 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +283 -0
- data/lib/dropbox-sign/models/template_edit_response.rb +250 -0
- data/lib/dropbox-sign/models/template_get_response.rb +261 -0
- data/lib/dropbox-sign/models/template_list_response.rb +273 -0
- data/lib/dropbox-sign/models/template_remove_user_request.rb +260 -0
- data/lib/dropbox-sign/models/template_response.rb +410 -0
- data/lib/dropbox-sign/models/template_response_account.rb +299 -0
- data/lib/dropbox-sign/models/template_response_account_quota.rb +281 -0
- data/lib/dropbox-sign/models/template_response_cc_role.rb +250 -0
- data/lib/dropbox-sign/models/template_response_custom_field.rb +407 -0
- data/lib/dropbox-sign/models/template_response_document.rb +309 -0
- data/lib/dropbox-sign/models/template_response_document_custom_field.rb +438 -0
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +260 -0
- data/lib/dropbox-sign/models/template_response_document_form_field.rb +417 -0
- data/lib/dropbox-sign/models/template_response_document_static_field.rb +341 -0
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +261 -0
- data/lib/dropbox-sign/models/template_response_named_form_field.rb +383 -0
- data/lib/dropbox-sign/models/template_response_signer_role.rb +260 -0
- data/lib/dropbox-sign/models/template_update_files_request.rb +336 -0
- data/lib/dropbox-sign/models/template_update_files_response.rb +249 -0
- data/lib/dropbox-sign/models/template_update_files_response_template.rb +263 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +728 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +631 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +586 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +261 -0
- data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +328 -0
- data/lib/dropbox-sign/models/unclaimed_draft_response.rb +305 -0
- data/lib/dropbox-sign/models/warning_response.rb +271 -0
- data/lib/dropbox-sign/version.rb +18 -0
- data/lib/dropbox-sign.rb +204 -0
- data/openapi-config.yaml +21 -0
- data/openapi-sdk.yaml +11080 -0
- data/run-build +53 -0
- data/spec/api/account_api_spec.rb +107 -0
- data/spec/api/api_app_api_spec.rb +95 -0
- data/spec/api/bulk_send_job_api_spec.rb +52 -0
- data/spec/api/embedded_api_spec.rb +55 -0
- data/spec/api/oauth_api_spec.rb +55 -0
- data/spec/api/report_api_spec.rb +38 -0
- data/spec/api/signature_request_api_spec.rb +263 -0
- data/spec/api/team_api_spec.rb +105 -0
- data/spec/api/template_api_spec.rb +147 -0
- data/spec/api/unclaimed_draft_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/event_callback_helper_spec.rb +22 -0
- data/spec/fixtures_spec.rb +59 -0
- data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
- data/spec/spec_helper.rb +111 -0
- data/spec/test_utils.rb +19 -0
- data/templates/Gemfile.mustache +10 -0
- data/templates/README.mustache +133 -0
- data/templates/Rakefile.mustache +10 -0
- data/templates/api.mustache +283 -0
- data/templates/api_client.mustache +291 -0
- data/templates/api_client_faraday_partial.mustache +136 -0
- data/templates/api_client_spec.mustache +220 -0
- data/templates/api_client_typhoeus_partial.mustache +153 -0
- data/templates/api_doc.mustache +77 -0
- data/templates/api_error.mustache +52 -0
- data/templates/api_info.mustache +12 -0
- data/templates/api_test.mustache +47 -0
- data/templates/base_object.mustache +132 -0
- data/templates/configuration.mustache +372 -0
- data/templates/configuration_spec.mustache +34 -0
- data/templates/configuration_tls_faraday_partial.mustache +29 -0
- data/templates/configuration_tls_typhoeus_partial.mustache +34 -0
- data/templates/event_callback_helper.mustache +46 -0
- data/templates/gem.mustache +55 -0
- data/templates/gemspec.mustache +35 -0
- data/templates/git_push.sh.mustache +57 -0
- data/templates/gitignore.mustache +41 -0
- data/templates/model.mustache +29 -0
- data/templates/model_doc.mustache +12 -0
- data/templates/model_test.mustache +77 -0
- data/templates/partial_model_enum_class.mustache +20 -0
- data/templates/partial_model_generic.mustache +414 -0
- data/templates/partial_model_generic_doc.mustache +10 -0
- data/templates/partial_oneof_module.mustache +137 -0
- data/templates/partial_oneof_module_doc.mustache +92 -0
- data/templates/rspec.mustache +2 -0
- data/templates/rubocop.mustache +148 -0
- data/templates/spec_helper.mustache +103 -0
- data/templates/travis.mustache +14 -0
- data/templates/version.mustache +10 -0
- data/test_fixtures/AccountCreateRequest.json +7 -0
- data/test_fixtures/AccountCreateResponse.json +15 -0
- data/test_fixtures/AccountGetResponse.json +14 -0
- data/test_fixtures/AccountUpdateRequest.json +5 -0
- data/test_fixtures/AccountVerifyRequest.json +5 -0
- data/test_fixtures/AccountVerifyResponse.json +7 -0
- data/test_fixtures/ApiAppCreateRequest.json +35 -0
- data/test_fixtures/ApiAppGetResponse.json +27 -0
- data/test_fixtures/ApiAppListResponse.json +42 -0
- data/test_fixtures/ApiAppUpdateRequest.json +35 -0
- data/test_fixtures/BulkSendJobGetResponse.json +67 -0
- data/test_fixtures/BulkSendJobListResponse.json +24 -0
- data/test_fixtures/BulkSendJobSendResponse.json +10 -0
- data/test_fixtures/EmbeddedEditUrlRequest.json +28 -0
- data/test_fixtures/EmbeddedEditUrlResponse.json +8 -0
- data/test_fixtures/EmbeddedSignUrlResponse.json +8 -0
- data/test_fixtures/ErrorResponse.json +9 -0
- data/test_fixtures/EventCallbackHelper.json +50 -0
- data/test_fixtures/FileResponse.json +6 -0
- data/test_fixtures/OAuthTokenGenerateRequest.json +9 -0
- data/test_fixtures/OAuthTokenRefreshRequest.json +6 -0
- data/test_fixtures/OAuthTokenResponse.json +15 -0
- data/test_fixtures/ReportCreateRequest.json +10 -0
- data/test_fixtures/ReportCreateResponse.json +13 -0
- data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +67 -0
- data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +66 -0
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +252 -0
- data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +60 -0
- data/test_fixtures/SignatureRequestGetResponse.json +146 -0
- data/test_fixtures/SignatureRequestListResponse.json +102 -0
- data/test_fixtures/SignatureRequestRemindRequest.json +5 -0
- data/test_fixtures/SignatureRequestSendRequest.json +463 -0
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +48 -0
- data/test_fixtures/SignatureRequestUpdateRequest.json +7 -0
- data/test_fixtures/SubFormFieldsPerDocument.json +107 -0
- data/test_fixtures/TeamAddMemberRequest.json +6 -0
- data/test_fixtures/TeamCreateRequest.json +5 -0
- data/test_fixtures/TeamGetResponse.json +34 -0
- data/test_fixtures/TeamRemoveMemberRequest.json +7 -0
- data/test_fixtures/TeamUpdateRequest.json +5 -0
- data/test_fixtures/TemplateAddUserRequest.json +7 -0
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +118 -0
- data/test_fixtures/TemplateCreateEmbeddedDraftResponse.json +9 -0
- data/test_fixtures/TemplateGetResponse.json +102 -0
- data/test_fixtures/TemplateListResponse.json +143 -0
- data/test_fixtures/TemplateRemoveUserRequest.json +6 -0
- data/test_fixtures/TemplateUpdateFilesRequest.json +11 -0
- data/test_fixtures/TemplateUpdateFilesResponse.json +7 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +134 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +67 -0
- data/test_fixtures/UnclaimedDraftCreateRequest.json +119 -0
- data/test_fixtures/UnclaimedDraftCreateResponse.json +9 -0
- data/test_fixtures/UnclaimedDraftEditAndResendRequest.json +15 -0
- data/test_fixtures/bulk-send-sample.csv +3 -0
- data/test_fixtures/pdf-sample-2.pdf +0 -0
- data/test_fixtures/pdf-sample.pdf +0 -0
- data/vendor/autoload.php +7 -0
- data/vendor/bin/yaml-lint +117 -0
- data/vendor/composer/ClassLoader.php +572 -0
- data/vendor/composer/InstalledVersions.php +350 -0
- data/vendor/composer/LICENSE +21 -0
- data/vendor/composer/autoload_classmap.php +10 -0
- data/vendor/composer/autoload_files.php +11 -0
- data/vendor/composer/autoload_namespaces.php +9 -0
- data/vendor/composer/autoload_psr4.php +11 -0
- data/vendor/composer/autoload_real.php +80 -0
- data/vendor/composer/autoload_static.php +46 -0
- data/vendor/composer/installed.json +239 -0
- data/vendor/composer/installed.php +50 -0
- data/vendor/composer/platform_check.php +26 -0
- data/vendor/symfony/deprecation-contracts/.gitignore +3 -0
- data/vendor/symfony/deprecation-contracts/CHANGELOG.md +5 -0
- data/vendor/symfony/deprecation-contracts/LICENSE +19 -0
- data/vendor/symfony/deprecation-contracts/README.md +26 -0
- data/vendor/symfony/deprecation-contracts/composer.json +35 -0
- data/vendor/symfony/deprecation-contracts/function.php +27 -0
- data/vendor/symfony/polyfill-ctype/Ctype.php +232 -0
- data/vendor/symfony/polyfill-ctype/LICENSE +19 -0
- data/vendor/symfony/polyfill-ctype/README.md +12 -0
- data/vendor/symfony/polyfill-ctype/bootstrap.php +50 -0
- data/vendor/symfony/polyfill-ctype/bootstrap80.php +46 -0
- data/vendor/symfony/polyfill-ctype/composer.json +41 -0
- data/vendor/symfony/yaml/CHANGELOG.md +237 -0
- data/vendor/symfony/yaml/Command/LintCommand.php +289 -0
- data/vendor/symfony/yaml/Dumper.php +140 -0
- data/vendor/symfony/yaml/Escaper.php +95 -0
- data/vendor/symfony/yaml/Exception/DumpException.php +21 -0
- data/vendor/symfony/yaml/Exception/ExceptionInterface.php +21 -0
- data/vendor/symfony/yaml/Exception/ParseException.php +132 -0
- data/vendor/symfony/yaml/Exception/RuntimeException.php +21 -0
- data/vendor/symfony/yaml/Inline.php +812 -0
- data/vendor/symfony/yaml/LICENSE +19 -0
- data/vendor/symfony/yaml/Parser.php +1305 -0
- data/vendor/symfony/yaml/README.md +13 -0
- data/vendor/symfony/yaml/Resources/bin/yaml-lint +45 -0
- data/vendor/symfony/yaml/Tag/TaggedValue.php +38 -0
- data/vendor/symfony/yaml/Unescaper.php +132 -0
- data/vendor/symfony/yaml/Yaml.php +100 -0
- data/vendor/symfony/yaml/composer.json +42 -0
- metadata +650 -0
@@ -0,0 +1,34 @@
|
|
1
|
+
# Dropbox::Sign::TemplateCreateEmbeddedDraftRequest
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | |
|
10
|
+
| `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
11
|
+
| `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
12
|
+
| `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [default to true] |
|
13
|
+
| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**Note**: Only available for Premium plan and higher. | [default to false] |
|
14
|
+
| `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
|
15
|
+
| `cc_roles` | ```Array<String>``` | The CC roles that must be assigned when using the template to send a signature request | |
|
16
|
+
| `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | |
|
17
|
+
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
18
|
+
| `force_signer_roles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | [default to false] |
|
19
|
+
| `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the template subject and message. | [default to false] |
|
20
|
+
| `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | |
|
21
|
+
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
22
|
+
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
|
23
|
+
| `merge_fields` | [```Array<SubMergeField>```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | |
|
24
|
+
| `message` | ```String``` | The default template email message. | |
|
25
|
+
| `metadata` | ```Hash<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
|
26
|
+
| `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.<br><br>- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] |
|
27
|
+
| `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] |
|
28
|
+
| `signer_roles` | [```Array<SubTemplateRole>```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
|
29
|
+
| `skip_me_now` | ```Boolean``` | Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`. | [default to false] |
|
30
|
+
| `subject` | ```String``` | The template title (alias). | |
|
31
|
+
| `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
|
32
|
+
| `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
|
33
|
+
| `use_preexisting_fields` | ```Boolean``` | Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). | [default to false] |
|
34
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateCreateEmbeddedDraftResponse
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `template` | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | |
|
10
|
+
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
|
11
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate
|
2
|
+
|
3
|
+
Template object with parameters: `template_id`, `edit_url`, `expires_at`.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `template_id` | ```String``` | The id of the Template. | |
|
10
|
+
| `edit_url` | ```String``` | Link to edit the template. | |
|
11
|
+
| `expires_at` | ```Integer``` | When the link expires. | |
|
12
|
+
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
|
13
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateGetResponse
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `template` | [```TemplateResponse```](TemplateResponse.md) | | |
|
10
|
+
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Dropbox::Sign::TemplateListResponse
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `templates` | [```Array<TemplateResponse>```](TemplateResponse.md) | List of templates that the API caller has access to. | |
|
10
|
+
| `list_info` | [```ListInfoResponse```](ListInfoResponse.md) | | |
|
11
|
+
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
|
12
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateRemoveUserRequest
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `account_id` | ```String``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | |
|
10
|
+
| `email_address` | ```String``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | |
|
11
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponse
|
2
|
+
|
3
|
+
Contains information about the templates you and your team have created.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `template_id` | ```String``` | The id of the Template. | |
|
10
|
+
| `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. | |
|
11
|
+
| `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. | |
|
12
|
+
| `updated_at` | ```Integer``` | Time the template was last updated. | |
|
13
|
+
| `is_embedded` | ```Boolean``` | `true` if this template was created using an embedded flow, `false` if it was created on our website. | |
|
14
|
+
| `is_creator` | ```Boolean``` | `true` if you are the owner of this template, `false` if it's been shared with you by a team member. | |
|
15
|
+
| `can_edit` | ```Boolean``` | Indicates whether edit rights have been granted to you by the owner (always `true` if that's you). | |
|
16
|
+
| `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. | |
|
17
|
+
| `metadata` | ```Object``` | The metadata attached to the template. | |
|
18
|
+
| `signer_roles` | [```Array<TemplateResponseSignerRole>```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
|
19
|
+
| `cc_roles` | [```Array<TemplateResponseCCRole>```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | |
|
20
|
+
| `documents` | [```Array<TemplateResponseDocument>```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | |
|
21
|
+
| `custom_fields` | [```Array<TemplateResponseCustomField>```](TemplateResponseCustomField.md) | An array of Custom Field objects. | |
|
22
|
+
| `named_form_fields` | [```Array<TemplateResponseNamedFormField>```](TemplateResponseNamedFormField.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. | |
|
23
|
+
| `accounts` | [```Array<TemplateResponseAccount>```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | |
|
24
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseAccount
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `account_id` | ```String``` | The id of the Account. | |
|
10
|
+
| `email_address` | ```String``` | The email address associated with the Account. | |
|
11
|
+
| `is_locked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | |
|
12
|
+
| `is_paid_hs` | ```Boolean``` | Returns `true` if the user has a paid Dropbox Sign account. | |
|
13
|
+
| `is_paid_hf` | ```Boolean``` | Returns `true` if the user has a paid HelloFax account. | |
|
14
|
+
| `quotas` | [```TemplateResponseAccountQuota```](TemplateResponseAccountQuota.md) | | |
|
15
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseAccountQuota
|
2
|
+
|
3
|
+
An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `templates_left` | ```Integer``` | API templates remaining. | |
|
10
|
+
| `api_signature_requests_left` | ```Integer``` | API signature requests remaining. | |
|
11
|
+
| `documents_left` | ```Integer``` | Signature requests remaining. | |
|
12
|
+
| `sms_verifications_left` | ```Integer``` | SMS verifications remaining. | |
|
13
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseCustomField
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `name` | ```String``` | The name of the Custom Field. | |
|
10
|
+
| `type` | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported. | |
|
11
|
+
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
12
|
+
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
13
|
+
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
14
|
+
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
15
|
+
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
16
|
+
| `api_id` | ```String``` | The unique ID for this field. | |
|
17
|
+
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
18
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
19
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
20
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
21
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
22
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocument
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `name` | ```String``` | Name of the associated file. | |
|
10
|
+
| `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | |
|
11
|
+
| `field_groups` | [```Array<TemplateResponseDocumentFieldGroup>```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | |
|
12
|
+
| `form_fields` | [```Array<TemplateResponseDocumentFormField>```](TemplateResponseDocumentFormField.md) | An array of Form Field objects containing the name and type of each named textbox and checkmark field. | |
|
13
|
+
| `custom_fields` | [```Array<TemplateResponseDocumentCustomField>```](TemplateResponseDocumentCustomField.md) | An array of Document Custom Field objects. | |
|
14
|
+
| `static_fields` | [```Array<TemplateResponseDocumentStaticField>```](TemplateResponseDocumentStaticField.md) | An array describing static overlay fields. <b>Note</b> only available for certain subscriptions. | |
|
15
|
+
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentCustomField
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `name` | ```String``` | The name of the Custom Field. | |
|
10
|
+
| `type` | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported. | |
|
11
|
+
| `signer` | ```String``` | The signer of the Custom Field. | |
|
12
|
+
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
13
|
+
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
14
|
+
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
15
|
+
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
16
|
+
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
17
|
+
| `api_id` | ```String``` | The unique ID for this field. | |
|
18
|
+
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
19
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
20
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
21
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
22
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
23
|
+
| `named_form_fields` | ```Object``` | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | |
|
24
|
+
| `reusable_form_id` | ```String``` | | |
|
25
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFieldGroup
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `name` | ```String``` | The name of the form field group. | |
|
10
|
+
| `rule` | ```String``` | The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping). | |
|
11
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormField
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `api_id` | ```String``` | A unique id for the form field. | |
|
10
|
+
| `name` | ```String``` | The name of the form field. | |
|
11
|
+
| `type` | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types). | |
|
12
|
+
| `signer` | ```String``` | The signer of the Form Field. | |
|
13
|
+
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
14
|
+
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
15
|
+
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
16
|
+
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
17
|
+
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
18
|
+
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
19
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
20
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
21
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
22
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticField
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `name` | ```String``` | The name of the static field. | |
|
10
|
+
| `type` | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types). | |
|
11
|
+
| `signer` | ```String``` | The signer of the Static Field. | |
|
12
|
+
| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | |
|
13
|
+
| `y` | ```Integer``` | The vertical offset in pixels for this static field. | |
|
14
|
+
| `width` | ```Integer``` | The width in pixels of this static field. | |
|
15
|
+
| `height` | ```Integer``` | The height in pixels of this static field. | |
|
16
|
+
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
17
|
+
| `api_id` | ```String``` | A unique id for the static field. | |
|
18
|
+
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
19
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseFieldAvgTextLength
|
2
|
+
|
3
|
+
Average text length in this field.
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `num_lines` | ```Integer``` | Number of lines. | |
|
10
|
+
| `num_chars_per_line` | ```Integer``` | Number of character per line. | |
|
11
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseNamedFormField
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `name` | ```String``` | The name of the Named Form Field. | |
|
10
|
+
| `type` | ```String``` | The type of this Named Form Field. Only `text` and `checkbox` are currently supported. | |
|
11
|
+
| `signer` | ```String``` | The signer of the Named Form Field. | |
|
12
|
+
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
13
|
+
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
14
|
+
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
15
|
+
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
16
|
+
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
17
|
+
| `api_id` | ```String``` | The unique ID for this field. | |
|
18
|
+
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
19
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
20
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
21
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
22
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
23
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseSignerRole
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `name` | ```String``` | The name of the Role. | |
|
10
|
+
| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | |
|
11
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Dropbox::Sign::TemplateUpdateFilesRequest
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `client_id` | ```String``` | Client id of the app you're using to update this template. | |
|
10
|
+
| `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to use for the template.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
11
|
+
| `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
12
|
+
| `message` | ```String``` | The new default template email message. | |
|
13
|
+
| `subject` | ```String``` | The new default template email subject. | |
|
14
|
+
| `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
|
15
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateUpdateFilesResponseTemplate
|
2
|
+
|
3
|
+
Contains template id
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `template_id` | ```String``` | The id of the Template. | |
|
10
|
+
| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
|
11
|
+
|