docspring 4.5.0 → 4.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +38 -0
- data/README.md +1 -1
- data/lib/docspring/api/client.rb +10 -4
- data/lib/docspring/api_client.rb +1 -1
- data/lib/docspring/models/combined_pdf.rb +1 -1
- data/lib/docspring/models/create_account_email_action_request.rb +1 -1
- data/lib/docspring/models/create_combined_pdf_request.rb +1 -1
- data/lib/docspring/models/create_email_action_request.rb +1 -1
- data/lib/docspring/models/create_submission_request.rb +5 -5
- data/lib/docspring/models/create_template_request.rb +76 -12
- data/lib/docspring/models/email_action.rb +1 -1
- data/lib/docspring/models/error_info.rb +1 -1
- data/lib/docspring/models/field.rb +166 -3
- data/lib/docspring/models/field_input.rb +77 -3
- data/lib/docspring/models/field_override.rb +55 -2
- data/lib/docspring/models/generated_file.rb +2 -2
- data/lib/docspring/models/number_part.rb +42 -0
- data/lib/docspring/models/predefined_field.rb +14 -1
- data/lib/docspring/models/predefined_field_input.rb +14 -1
- data/lib/docspring/models/signature_request.rb +3 -3
- data/lib/docspring/models/signature_request_input.rb +3 -10
- data/lib/docspring/models/submission.rb +3 -3
- data/lib/docspring/models/submission_files.rb +11 -1
- data/lib/docspring/models/submission_input.rb +2 -2
- data/lib/docspring/models/submission_summary.rb +1 -1
- data/lib/docspring/models/template.rb +154 -15
- data/lib/docspring/models/template_defaults.rb +1 -1
- data/lib/docspring/models/template_defaults_input.rb +1 -1
- data/lib/docspring/models/template_signer_role.rb +265 -0
- data/lib/docspring/models/template_signer_role_input.rb +227 -0
- data/lib/docspring/models/update_account_email_action_request.rb +1 -1
- data/lib/docspring/models/update_email_action_customization_request.rb +1 -1
- data/lib/docspring/models/update_email_action_request.rb +1 -1
- data/lib/docspring/models/update_template_document_request.rb +14 -4
- data/lib/docspring/models/update_template_request.rb +80 -16
- data/lib/docspring/models/validate_submission_request.rb +5 -5
- data/lib/docspring/request_schemas.json +278 -12
- data/lib/docspring/version.rb +1 -1
- data/lib/docspring.rb +3 -0
- metadata +5 -591
- data/.github/workflows/release.yml +0 -80
- data/.gitignore +0 -39
- data/.openapi-generator/FILES +0 -593
- data/.openapi-generator/VERSION +0 -1
- data/.openapi-generator-ignore +0 -23
- data/.rspec +0 -2
- data/.rubocop.yml +0 -148
- data/Gemfile +0 -9
- data/Gemfile.lock +0 -146
- data/Rakefile +0 -10
- data/docs/AddTemplateFieldsRequest.md +0 -18
- data/docs/AiFieldNamingLanguage.md +0 -15
- data/docs/AuthenticationCheck.md +0 -18
- data/docs/BarcodeSymbology.md +0 -15
- data/docs/CheckCharacter.md +0 -15
- data/docs/Client.md +0 -5890
- data/docs/CombinedFieldType.md +0 -15
- data/docs/CombinedPdf.md +0 -44
- data/docs/CombinedPdfFiles.md +0 -18
- data/docs/CombinedPdfList.md +0 -20
- data/docs/CombinedPdfSource.md +0 -26
- data/docs/CombinedPdfSourceInput.md +0 -88
- data/docs/CombinedPdfSourcePdf.md +0 -20
- data/docs/CombinedPdfSourceType.md +0 -15
- data/docs/CombinedPdfState.md +0 -15
- data/docs/CopyTemplateRequest.md +0 -22
- data/docs/CreateAccountEmailActionRequest.md +0 -54
- data/docs/CreateCombinedPdfRequest.md +0 -26
- data/docs/CreateCustomFileFromUploadRequest.md +0 -18
- data/docs/CreateEmailActionRequest.md +0 -50
- data/docs/CreateEmailDomainRequest.md +0 -18
- data/docs/CreateFolderRequest.md +0 -20
- data/docs/CreateSignatureRequestEventRequest.md +0 -24
- data/docs/CreateSignatureRequestTokenRequest.md +0 -18
- data/docs/CreateSubmissionBatchRequest.md +0 -28
- data/docs/CreateSubmissionRequest.md +0 -56
- data/docs/CreateTemplatePreviewRequest.md +0 -18
- data/docs/CreateTemplateRequest.md +0 -130
- data/docs/CreateWebhookRequest.md +0 -38
- data/docs/CustomFile.md +0 -28
- data/docs/CustomFileList.md +0 -20
- data/docs/CustomFileSourcePdf.md +0 -20
- data/docs/DnsRecordType.md +0 -15
- data/docs/EmailAction.md +0 -76
- data/docs/EmailActionConditions.md +0 -20
- data/docs/EmailActionConditionsInput.md +0 -20
- data/docs/EmailActionCustomization.md +0 -36
- data/docs/EmailActionDelivery.md +0 -15
- data/docs/EmailActionFileFormats.md +0 -15
- data/docs/EmailActionList.md +0 -20
- data/docs/EmailActionSetting.md +0 -15
- data/docs/EmailActionSubmissionType.md +0 -15
- data/docs/EmailActionTestEmail.md +0 -18
- data/docs/EmailDomain.md +0 -38
- data/docs/EmailDomainDnsRecord.md +0 -24
- data/docs/EmailDomainDnsRecordPurpose.md +0 -15
- data/docs/EmailDomainList.md +0 -20
- data/docs/EmailDomainRecordState.md +0 -15
- data/docs/EmailDomainState.md +0 -15
- data/docs/ErrorCode.md +0 -15
- data/docs/ErrorDetail.md +0 -26
- data/docs/ErrorInfo.md +0 -42
- data/docs/ErrorResponse.md +0 -18
- data/docs/ExpirationInterval.md +0 -15
- data/docs/Field.md +0 -198
- data/docs/FieldComparisonCondition.md +0 -22
- data/docs/FieldComparisonOperator.md +0 -15
- data/docs/FieldDependency.md +0 -22
- data/docs/FieldDependencyInput.md +0 -22
- data/docs/FieldDisplayType.md +0 -15
- data/docs/FieldEqualsCondition.md +0 -22
- data/docs/FieldEqualsOperator.md +0 -15
- data/docs/FieldGroup.md +0 -32
- data/docs/FieldGroupInput.md +0 -30
- data/docs/FieldGroupType.md +0 -15
- data/docs/FieldInCondition.md +0 -22
- data/docs/FieldInput.md +0 -196
- data/docs/FieldOverride.md +0 -142
- data/docs/FieldPresenceCondition.md +0 -20
- data/docs/FieldPresenceOperator.md +0 -15
- data/docs/FieldRangeCondition.md +0 -24
- data/docs/FieldReimportState.md +0 -15
- data/docs/FieldSetupLogic.md +0 -15
- data/docs/FieldSetupNaming.md +0 -15
- data/docs/FieldSetupSource.md +0 -15
- data/docs/FieldType.md +0 -15
- data/docs/Folder.md +0 -28
- data/docs/FolderList.md +0 -20
- data/docs/GenerateFilesFormat.md +0 -15
- data/docs/GenerateSubmissionFilesRequest.md +0 -18
- data/docs/GeneratedFile.md +0 -32
- data/docs/GeneratedFileState.md +0 -15
- data/docs/HtmlEngineOptions.md +0 -36
- data/docs/HtmlEngineOptionsInput.md +0 -36
- data/docs/ImageGravity.md +0 -15
- data/docs/ImageScaleType.md +0 -15
- data/docs/ModelCodeLanguage.md +0 -15
- data/docs/MoveFolderRequest.md +0 -18
- data/docs/MoveTemplateRequest.md +0 -18
- data/docs/NumberConditionType.md +0 -15
- data/docs/OutputFormat.md +0 -15
- data/docs/PageFormat.md +0 -15
- data/docs/PageImage.md +0 -34
- data/docs/PageImages.md +0 -24
- data/docs/PredefinedField.md +0 -30
- data/docs/PredefinedFieldInput.md +0 -30
- data/docs/PublishTemplateVersionRequest.md +0 -20
- data/docs/RemoveTemplateFieldsRequest.md +0 -18
- data/docs/RenameFolderRequest.md +0 -18
- data/docs/ReorderTemplateFieldsRequest.md +0 -18
- data/docs/RestoreTemplateVersionRequest.md +0 -18
- data/docs/SendAccountEmailActionTestEmailRequest.md +0 -18
- data/docs/ShapeType.md +0 -15
- data/docs/SignatureRequest.md +0 -74
- data/docs/SignatureRequestAuthSecondFactorType.md +0 -15
- data/docs/SignatureRequestAuthType.md +0 -15
- data/docs/SignatureRequestEmailAttachments.md +0 -15
- data/docs/SignatureRequestEmailStatus.md +0 -15
- data/docs/SignatureRequestEvent.md +0 -32
- data/docs/SignatureRequestEventType.md +0 -15
- data/docs/SignatureRequestInput.md +0 -50
- data/docs/SignatureRequestMessageType.md +0 -15
- data/docs/SignatureRequestReminders.md +0 -20
- data/docs/SignatureRequestState.md +0 -15
- data/docs/SignatureRequestToken.md +0 -30
- data/docs/SignatureRequestTokenType.md +0 -15
- data/docs/SigningOrder.md +0 -15
- data/docs/StringConditionType.md +0 -15
- data/docs/Submission.md +0 -68
- data/docs/SubmissionAction.md +0 -30
- data/docs/SubmissionActionState.md +0 -15
- data/docs/SubmissionActionType.md +0 -15
- data/docs/SubmissionBatch.md +0 -38
- data/docs/SubmissionBatchState.md +0 -15
- data/docs/SubmissionFiles.md +0 -28
- data/docs/SubmissionInput.md +0 -40
- data/docs/SubmissionList.md +0 -20
- data/docs/SubmissionSource.md +0 -15
- data/docs/SubmissionSourcePdf.md +0 -20
- data/docs/SubmissionState.md +0 -15
- data/docs/SubmissionSummary.md +0 -54
- data/docs/SubmissionValidation.md +0 -24
- data/docs/Template.md +0 -142
- data/docs/TemplateActor.md +0 -26
- data/docs/TemplateActorType.md +0 -15
- data/docs/TemplateDefaults.md +0 -56
- data/docs/TemplateDefaultsInput.md +0 -56
- data/docs/TemplateDiff.md +0 -30
- data/docs/TemplateDiffSummary.md +0 -28
- data/docs/TemplateDocument.md +0 -40
- data/docs/TemplateDocumentState.md +0 -15
- data/docs/TemplateDocumentSummary.md +0 -24
- data/docs/TemplateFieldChange.md +0 -24
- data/docs/TemplateFieldChanges.md +0 -24
- data/docs/TemplateFieldDependency.md +0 -26
- data/docs/TemplateFieldDependencyAction.md +0 -15
- data/docs/TemplateFieldDependencyCondition.md +0 -24
- data/docs/TemplateFieldDependencyConditionInput.md +0 -93
- data/docs/TemplateFieldDependencyInput.md +0 -26
- data/docs/TemplateFieldDependencyMatch.md +0 -15
- data/docs/TemplateFieldDependencyOperator.md +0 -15
- data/docs/TemplateFieldLogicStatus.md +0 -15
- data/docs/TemplateFieldMove.md +0 -22
- data/docs/TemplateFields.md +0 -22
- data/docs/TemplateFormMode.md +0 -15
- data/docs/TemplateFormSection.md +0 -24
- data/docs/TemplateFormSectionInput.md +0 -24
- data/docs/TemplateModelCode.md +0 -22
- data/docs/TemplatePageAiError.md +0 -15
- data/docs/TemplatePageAiNamingStatus.md +0 -15
- data/docs/TemplatePageFieldsStatus.md +0 -15
- data/docs/TemplatePageImageStatus.md +0 -15
- data/docs/TemplatePageImages.md +0 -24
- data/docs/TemplatePageProcessingStatus.md +0 -26
- data/docs/TemplatePreview.md +0 -32
- data/docs/TemplatePreviewState.md +0 -15
- data/docs/TemplateSourcePdf.md +0 -24
- data/docs/TemplateSummary.md +0 -46
- data/docs/TemplateSummaryList.md +0 -20
- data/docs/TemplateType.md +0 -15
- data/docs/TemplateVersion.md +0 -24
- data/docs/TemplateVersionType.md +0 -15
- data/docs/TextAlignment.md +0 -15
- data/docs/TextOverflow.md +0 -15
- data/docs/TextVerticalAlignment.md +0 -15
- data/docs/Typeface.md +0 -15
- data/docs/UpdateAccountEmailActionRequest.md +0 -54
- data/docs/UpdateEmailActionCustomizationRequest.md +0 -46
- data/docs/UpdateEmailActionRequest.md +0 -50
- data/docs/UpdateSignatureRequestRequest.md +0 -34
- data/docs/UpdateTemplateDocumentRequest.md +0 -26
- data/docs/UpdateTemplateFieldsRequest.md +0 -18
- data/docs/UpdateTemplateRequest.md +0 -114
- data/docs/UpdateWebhookRequest.md +0 -38
- data/docs/UploadMethod.md +0 -15
- data/docs/UploadPresign.md +0 -24
- data/docs/UrlSourcePdf.md +0 -20
- data/docs/ValidateSubmissionRequest.md +0 -56
- data/docs/Webhook.md +0 -56
- data/docs/WebhookEventType.md +0 -15
- data/docs/WebhookList.md +0 -20
- data/docs/WebhookMode.md +0 -15
- data/docspring.gemspec +0 -40
- data/spec/api/client_spec.rb +0 -1103
- data/spec/models/add_template_fields_request_spec.rb +0 -36
- data/spec/models/ai_field_naming_language_spec.rb +0 -30
- data/spec/models/authentication_check_spec.rb +0 -36
- data/spec/models/barcode_symbology_spec.rb +0 -30
- data/spec/models/check_character_spec.rb +0 -30
- data/spec/models/combined_field_type_spec.rb +0 -30
- data/spec/models/combined_pdf_files_spec.rb +0 -36
- data/spec/models/combined_pdf_list_spec.rb +0 -42
- data/spec/models/combined_pdf_source_input_spec.rb +0 -44
- data/spec/models/combined_pdf_source_pdf_spec.rb +0 -42
- data/spec/models/combined_pdf_source_spec.rb +0 -60
- data/spec/models/combined_pdf_source_type_spec.rb +0 -30
- data/spec/models/combined_pdf_spec.rb +0 -114
- data/spec/models/combined_pdf_state_spec.rb +0 -30
- data/spec/models/copy_template_request_spec.rb +0 -48
- data/spec/models/create_account_email_action_request_spec.rb +0 -144
- data/spec/models/create_combined_pdf_request_spec.rb +0 -60
- data/spec/models/create_custom_file_from_upload_request_spec.rb +0 -36
- data/spec/models/create_email_action_request_spec.rb +0 -132
- data/spec/models/create_email_domain_request_spec.rb +0 -36
- data/spec/models/create_folder_request_spec.rb +0 -42
- data/spec/models/create_signature_request_event_request_spec.rb +0 -54
- data/spec/models/create_signature_request_token_request_spec.rb +0 -36
- data/spec/models/create_submission_batch_request_spec.rb +0 -66
- data/spec/models/create_submission_request_spec.rb +0 -150
- data/spec/models/create_template_preview_request_spec.rb +0 -36
- data/spec/models/create_template_request_spec.rb +0 -372
- data/spec/models/create_webhook_request_spec.rb +0 -96
- data/spec/models/custom_file_list_spec.rb +0 -42
- data/spec/models/custom_file_source_pdf_spec.rb +0 -42
- data/spec/models/custom_file_spec.rb +0 -66
- data/spec/models/dns_record_type_spec.rb +0 -30
- data/spec/models/email_action_conditions_input_spec.rb +0 -42
- data/spec/models/email_action_conditions_spec.rb +0 -42
- data/spec/models/email_action_customization_spec.rb +0 -90
- data/spec/models/email_action_delivery_spec.rb +0 -30
- data/spec/models/email_action_file_formats_spec.rb +0 -30
- data/spec/models/email_action_list_spec.rb +0 -42
- data/spec/models/email_action_setting_spec.rb +0 -30
- data/spec/models/email_action_spec.rb +0 -210
- data/spec/models/email_action_submission_type_spec.rb +0 -30
- data/spec/models/email_action_test_email_spec.rb +0 -36
- data/spec/models/email_domain_dns_record_purpose_spec.rb +0 -30
- data/spec/models/email_domain_dns_record_spec.rb +0 -54
- data/spec/models/email_domain_list_spec.rb +0 -42
- data/spec/models/email_domain_record_state_spec.rb +0 -30
- data/spec/models/email_domain_spec.rb +0 -96
- data/spec/models/email_domain_state_spec.rb +0 -30
- data/spec/models/error_code_spec.rb +0 -30
- data/spec/models/error_detail_spec.rb +0 -60
- data/spec/models/error_info_spec.rb +0 -108
- data/spec/models/error_response_spec.rb +0 -36
- data/spec/models/expiration_interval_spec.rb +0 -30
- data/spec/models/field_comparison_condition_spec.rb +0 -48
- data/spec/models/field_comparison_operator_spec.rb +0 -30
- data/spec/models/field_dependency_input_spec.rb +0 -48
- data/spec/models/field_dependency_spec.rb +0 -48
- data/spec/models/field_display_type_spec.rb +0 -30
- data/spec/models/field_equals_condition_spec.rb +0 -48
- data/spec/models/field_equals_operator_spec.rb +0 -30
- data/spec/models/field_group_input_spec.rb +0 -72
- data/spec/models/field_group_spec.rb +0 -78
- data/spec/models/field_group_type_spec.rb +0 -30
- data/spec/models/field_in_condition_spec.rb +0 -48
- data/spec/models/field_input_spec.rb +0 -570
- data/spec/models/field_override_spec.rb +0 -408
- data/spec/models/field_presence_condition_spec.rb +0 -42
- data/spec/models/field_presence_operator_spec.rb +0 -30
- data/spec/models/field_range_condition_spec.rb +0 -54
- data/spec/models/field_reimport_state_spec.rb +0 -30
- data/spec/models/field_setup_logic_spec.rb +0 -30
- data/spec/models/field_setup_naming_spec.rb +0 -30
- data/spec/models/field_setup_source_spec.rb +0 -30
- data/spec/models/field_spec.rb +0 -576
- data/spec/models/field_type_spec.rb +0 -30
- data/spec/models/folder_list_spec.rb +0 -42
- data/spec/models/folder_spec.rb +0 -66
- data/spec/models/generate_files_format_spec.rb +0 -30
- data/spec/models/generate_submission_files_request_spec.rb +0 -36
- data/spec/models/generated_file_spec.rb +0 -78
- data/spec/models/generated_file_state_spec.rb +0 -30
- data/spec/models/html_engine_options_input_spec.rb +0 -90
- data/spec/models/html_engine_options_spec.rb +0 -90
- data/spec/models/image_gravity_spec.rb +0 -30
- data/spec/models/image_scale_type_spec.rb +0 -30
- data/spec/models/model_code_language_spec.rb +0 -30
- data/spec/models/move_folder_request_spec.rb +0 -36
- data/spec/models/move_template_request_spec.rb +0 -36
- data/spec/models/number_condition_type_spec.rb +0 -30
- data/spec/models/output_format_spec.rb +0 -30
- data/spec/models/page_format_spec.rb +0 -30
- data/spec/models/page_image_spec.rb +0 -84
- data/spec/models/page_images_spec.rb +0 -54
- data/spec/models/predefined_field_input_spec.rb +0 -72
- data/spec/models/predefined_field_spec.rb +0 -72
- data/spec/models/publish_template_version_request_spec.rb +0 -42
- data/spec/models/remove_template_fields_request_spec.rb +0 -36
- data/spec/models/rename_folder_request_spec.rb +0 -36
- data/spec/models/reorder_template_fields_request_spec.rb +0 -36
- data/spec/models/restore_template_version_request_spec.rb +0 -36
- data/spec/models/send_account_email_action_test_email_request_spec.rb +0 -36
- data/spec/models/shape_type_spec.rb +0 -30
- data/spec/models/signature_request_auth_second_factor_type_spec.rb +0 -30
- data/spec/models/signature_request_auth_type_spec.rb +0 -30
- data/spec/models/signature_request_email_attachments_spec.rb +0 -30
- data/spec/models/signature_request_email_status_spec.rb +0 -30
- data/spec/models/signature_request_event_spec.rb +0 -78
- data/spec/models/signature_request_event_type_spec.rb +0 -30
- data/spec/models/signature_request_input_spec.rb +0 -132
- data/spec/models/signature_request_message_type_spec.rb +0 -30
- data/spec/models/signature_request_reminders_spec.rb +0 -42
- data/spec/models/signature_request_spec.rb +0 -204
- data/spec/models/signature_request_state_spec.rb +0 -30
- data/spec/models/signature_request_token_spec.rb +0 -72
- data/spec/models/signature_request_token_type_spec.rb +0 -30
- data/spec/models/signing_order_spec.rb +0 -30
- data/spec/models/string_condition_type_spec.rb +0 -30
- data/spec/models/submission_action_spec.rb +0 -72
- data/spec/models/submission_action_state_spec.rb +0 -30
- data/spec/models/submission_action_type_spec.rb +0 -30
- data/spec/models/submission_batch_spec.rb +0 -96
- data/spec/models/submission_batch_state_spec.rb +0 -30
- data/spec/models/submission_files_spec.rb +0 -66
- data/spec/models/submission_input_spec.rb +0 -102
- data/spec/models/submission_list_spec.rb +0 -42
- data/spec/models/submission_source_pdf_spec.rb +0 -42
- data/spec/models/submission_source_spec.rb +0 -30
- data/spec/models/submission_spec.rb +0 -186
- data/spec/models/submission_state_spec.rb +0 -30
- data/spec/models/submission_summary_spec.rb +0 -144
- data/spec/models/submission_validation_spec.rb +0 -54
- data/spec/models/template_actor_spec.rb +0 -60
- data/spec/models/template_actor_type_spec.rb +0 -30
- data/spec/models/template_defaults_input_spec.rb +0 -150
- data/spec/models/template_defaults_spec.rb +0 -150
- data/spec/models/template_diff_spec.rb +0 -72
- data/spec/models/template_diff_summary_spec.rb +0 -66
- data/spec/models/template_document_spec.rb +0 -102
- data/spec/models/template_document_state_spec.rb +0 -30
- data/spec/models/template_document_summary_spec.rb +0 -54
- data/spec/models/template_field_change_spec.rb +0 -54
- data/spec/models/template_field_changes_spec.rb +0 -54
- data/spec/models/template_field_dependency_action_spec.rb +0 -30
- data/spec/models/template_field_dependency_condition_input_spec.rb +0 -44
- data/spec/models/template_field_dependency_condition_spec.rb +0 -54
- data/spec/models/template_field_dependency_input_spec.rb +0 -60
- data/spec/models/template_field_dependency_match_spec.rb +0 -30
- data/spec/models/template_field_dependency_operator_spec.rb +0 -30
- data/spec/models/template_field_dependency_spec.rb +0 -60
- data/spec/models/template_field_logic_status_spec.rb +0 -30
- data/spec/models/template_field_move_spec.rb +0 -48
- data/spec/models/template_fields_spec.rb +0 -48
- data/spec/models/template_form_mode_spec.rb +0 -30
- data/spec/models/template_form_section_input_spec.rb +0 -54
- data/spec/models/template_form_section_spec.rb +0 -54
- data/spec/models/template_model_code_spec.rb +0 -48
- data/spec/models/template_page_ai_error_spec.rb +0 -30
- data/spec/models/template_page_ai_naming_status_spec.rb +0 -30
- data/spec/models/template_page_fields_status_spec.rb +0 -30
- data/spec/models/template_page_image_status_spec.rb +0 -30
- data/spec/models/template_page_images_spec.rb +0 -54
- data/spec/models/template_page_processing_status_spec.rb +0 -60
- data/spec/models/template_preview_spec.rb +0 -78
- data/spec/models/template_preview_state_spec.rb +0 -30
- data/spec/models/template_source_pdf_spec.rb +0 -54
- data/spec/models/template_spec.rb +0 -408
- data/spec/models/template_summary_list_spec.rb +0 -42
- data/spec/models/template_summary_spec.rb +0 -120
- data/spec/models/template_type_spec.rb +0 -30
- data/spec/models/template_version_spec.rb +0 -54
- data/spec/models/template_version_type_spec.rb +0 -30
- data/spec/models/text_alignment_spec.rb +0 -30
- data/spec/models/text_overflow_spec.rb +0 -30
- data/spec/models/text_vertical_alignment_spec.rb +0 -30
- data/spec/models/typeface_spec.rb +0 -30
- data/spec/models/update_account_email_action_request_spec.rb +0 -144
- data/spec/models/update_email_action_customization_request_spec.rb +0 -120
- data/spec/models/update_email_action_request_spec.rb +0 -132
- data/spec/models/update_signature_request_request_spec.rb +0 -84
- data/spec/models/update_template_document_request_spec.rb +0 -60
- data/spec/models/update_template_fields_request_spec.rb +0 -36
- data/spec/models/update_template_request_spec.rb +0 -324
- data/spec/models/update_webhook_request_spec.rb +0 -96
- data/spec/models/upload_method_spec.rb +0 -30
- data/spec/models/upload_presign_spec.rb +0 -54
- data/spec/models/url_source_pdf_spec.rb +0 -42
- data/spec/models/validate_submission_request_spec.rb +0 -150
- data/spec/models/webhook_event_type_spec.rb +0 -30
- data/spec/models/webhook_list_spec.rb +0 -42
- data/spec/models/webhook_mode_spec.rb +0 -30
- data/spec/models/webhook_spec.rb +0 -150
- data/spec/spec_helper.rb +0 -111
|
@@ -40,16 +40,19 @@ module DocSpring
|
|
|
40
40
|
# Accept submission data with properties that aren't fields of the template.
|
|
41
41
|
attr_accessor :allow_additional_properties
|
|
42
42
|
|
|
43
|
-
# Visual
|
|
43
|
+
# Visual Forms JS 2.16.0 to 2.23.0 only: with it on, Continue takes the place of Next once the required fields are filled in. Later versions use `continue_before_optional_fields`.
|
|
44
44
|
attr_accessor :allow_skipping_optional_fields
|
|
45
45
|
|
|
46
|
+
# Visual forms and signature request forms show the Continue button next to Next as soon as the required fields are filled in, without visiting each optional field. Turned off, Continue shows in place of Next only once every field has a value or has been visited. The `allowSkippingOptionalFields` embed option overrides it.
|
|
47
|
+
attr_accessor :continue_before_optional_fields
|
|
48
|
+
|
|
46
49
|
# The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). Only PDF templates have a visual form, so other templates accept only `web`.
|
|
47
50
|
attr_accessor :default_form_mode
|
|
48
51
|
|
|
49
52
|
# Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
|
|
50
53
|
attr_accessor :editable_submissions
|
|
51
54
|
|
|
52
|
-
# The sites that can embed the template's live signature requests
|
|
55
|
+
# The sites that can embed the template's live signature requests, its embedded template editor and its visual form: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work), without a path. Each one is stored in lowercase, without a trailing slash. Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. A visual form embedded with Visual Forms JS loads only on these sites, and on any site when the list is empty. Web Forms JS isn't restricted.
|
|
53
56
|
attr_accessor :embed_domains
|
|
54
57
|
|
|
55
58
|
# Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
|
|
@@ -67,10 +70,10 @@ module DocSpring
|
|
|
67
70
|
# The password that opens encrypted PDFs. It's never returned; `has_encrypt_pdfs_password` says if it's set.
|
|
68
71
|
attr_accessor :encrypt_pdfs_password
|
|
69
72
|
|
|
70
|
-
# Delete each submission's data and
|
|
73
|
+
# Delete each submission's data and files after `expire_after` `expiration_interval`, when `override_account_expiry` is on.
|
|
71
74
|
attr_accessor :expire_submissions
|
|
72
75
|
|
|
73
|
-
# How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions`
|
|
76
|
+
# How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` and `override_account_expiry` are on. At most 5256000 (10 years in minutes).
|
|
74
77
|
attr_accessor :expire_after
|
|
75
78
|
|
|
76
79
|
# The unit of `expire_after`.
|
|
@@ -91,25 +94,25 @@ module DocSpring
|
|
|
91
94
|
# Where the web form sends people after they submit it, instead of showing its success screen. After its `?` or `#`, it can have variables such as `{{ data.first_name }}`, which the form fills in with what they submitted.
|
|
92
95
|
attr_accessor :redirect_url
|
|
93
96
|
|
|
94
|
-
# How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached.
|
|
97
|
+
# How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. A signature request uses the value it had when the request was created.
|
|
95
98
|
attr_accessor :signature_request_email_attachments
|
|
96
99
|
|
|
97
|
-
# The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name.
|
|
100
|
+
# The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name.
|
|
98
101
|
attr_accessor :signature_request_from_address
|
|
99
102
|
|
|
100
|
-
# Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign.
|
|
103
|
+
# Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign.
|
|
101
104
|
attr_accessor :signature_request_include_signing_token
|
|
102
105
|
|
|
103
|
-
# The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name.
|
|
106
|
+
# The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name.
|
|
104
107
|
attr_accessor :signature_request_from_name
|
|
105
108
|
|
|
106
|
-
# Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them.
|
|
109
|
+
# Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them.
|
|
107
110
|
attr_accessor :signature_request_notification_emails
|
|
108
111
|
|
|
109
|
-
# Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it.
|
|
112
|
+
# Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it.
|
|
110
113
|
attr_accessor :signature_request_reply_to
|
|
111
114
|
|
|
112
|
-
# A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page.
|
|
115
|
+
# A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page.
|
|
113
116
|
attr_accessor :signature_request_signing_url
|
|
114
117
|
|
|
115
118
|
# The title of the web form's success screen. When it's null or empty, the screen says "Thanks for filling out" and the template's name. It can have variables such as `{{ data.first_name }}`.
|
|
@@ -121,6 +124,9 @@ module DocSpring
|
|
|
121
124
|
# Whether the web form's success screen has a "Fill out again" button, which clears the form so someone can fill it in again.
|
|
122
125
|
attr_accessor :show_fill_again_button
|
|
123
126
|
|
|
127
|
+
# Whether a web form with sections makes people fill them out in order. When true, a later section stays locked until they reach it with Next. When false, they can open any section from the list, and Next and Submit still check their answers.
|
|
128
|
+
attr_accessor :form_sections_in_order
|
|
129
|
+
|
|
124
130
|
# A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set.
|
|
125
131
|
attr_accessor :slack_webhook_url
|
|
126
132
|
|
|
@@ -136,6 +142,12 @@ module DocSpring
|
|
|
136
142
|
# The web form's sections, in order. Setting them replaces all of the sections; an empty list removes them.
|
|
137
143
|
attr_accessor :form_sections
|
|
138
144
|
|
|
145
|
+
# The template's signer roles, in order. Setting them replaces the whole list: a role left out is deleted, and its fields are left unassigned. Give each role you keep its `id`.
|
|
146
|
+
attr_accessor :signer_roles
|
|
147
|
+
|
|
148
|
+
# Who gets a copy of the completed document when DocSpring emails a submission's signers, with the submission's `cc`: email addresses, or `{{ variables }}` that name an address in the submission's data, such as `{{ agent.email }}`. A value the data doesn't have prints nothing, and an address that comes out blank is left out. The data has to have the value, so it's one of the template's fields (one the sender fills in) or the template allows additional properties: setting a variable that isn't a field is a `422` otherwise. They don't sign. Setting it replaces the whole list.
|
|
149
|
+
attr_accessor :signature_request_cc
|
|
150
|
+
|
|
139
151
|
# The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
|
|
140
152
|
attr_accessor :predefined_fields
|
|
141
153
|
|
|
@@ -163,6 +175,12 @@ module DocSpring
|
|
|
163
175
|
# A page design's layout: its page setup, its sections and the elements placed in them, in the Page Designer layout format (https://docspring.com/docs/page-designer/layout-format/). Its JSON Schema is at https://docspring.com/schemas/page-designer/layout.v1.json. Null for other templates. Setting it replaces the whole layout, and DocSpring adds a field for each value it reads. Left out when a page design is created, it starts with an empty page.
|
|
164
176
|
attr_accessor :layout
|
|
165
177
|
|
|
178
|
+
# Whether the template's own expiry (`expire_submissions`, `expire_after` and `expiration_interval`) decides when all its submissions are deleted, with or without signature requests, including keeping them until you delete them. When false, the account's expiry settings do. Turning `expire_submissions` on also turns this on, unless the same request sets it, and so does creating a template with `expire_submissions` on or off.
|
|
179
|
+
attr_accessor :override_account_expiry
|
|
180
|
+
|
|
181
|
+
# Add a field for each value the template's code or layout reads for the first time, with a type worked out from how it's used. Existing fields keep their settings, and a field you deleted while the code still read the value stays deleted. Default true. Set it to false to manage the fields yourself with the fields endpoints: a form field whose field isn't on the template then fails its submissions and previews. Only for HTML templates and page designs: a Word template takes it with its document, in PUT /templates/{template_id}/document or PUT /templates/{template_id}/document/upload.
|
|
182
|
+
attr_accessor :sync_fields
|
|
183
|
+
|
|
166
184
|
class EnumAttributeValidator
|
|
167
185
|
attr_reader :datatype
|
|
168
186
|
attr_reader :allowable_values
|
|
@@ -197,6 +215,7 @@ module DocSpring
|
|
|
197
215
|
:'ai_field_naming_language' => :'ai_field_naming_language',
|
|
198
216
|
:'allow_additional_properties' => :'allow_additional_properties',
|
|
199
217
|
:'allow_skipping_optional_fields' => :'allow_skipping_optional_fields',
|
|
218
|
+
:'continue_before_optional_fields' => :'continue_before_optional_fields',
|
|
200
219
|
:'default_form_mode' => :'default_form_mode',
|
|
201
220
|
:'editable_submissions' => :'editable_submissions',
|
|
202
221
|
:'embed_domains' => :'embed_domains',
|
|
@@ -223,11 +242,14 @@ module DocSpring
|
|
|
223
242
|
:'success_title' => :'success_title',
|
|
224
243
|
:'success_message' => :'success_message',
|
|
225
244
|
:'show_fill_again_button' => :'show_fill_again_button',
|
|
245
|
+
:'form_sections_in_order' => :'form_sections_in_order',
|
|
226
246
|
:'slack_webhook_url' => :'slack_webhook_url',
|
|
227
247
|
:'defaults' => :'defaults',
|
|
228
248
|
:'field_dependencies' => :'field_dependencies',
|
|
229
249
|
:'field_groups' => :'field_groups',
|
|
230
250
|
:'form_sections' => :'form_sections',
|
|
251
|
+
:'signer_roles' => :'signer_roles',
|
|
252
|
+
:'signature_request_cc' => :'signature_request_cc',
|
|
231
253
|
:'predefined_fields' => :'predefined_fields',
|
|
232
254
|
:'predefined_fields_sample_data' => :'predefined_fields_sample_data',
|
|
233
255
|
:'html' => :'html',
|
|
@@ -236,7 +258,9 @@ module DocSpring
|
|
|
236
258
|
:'footer_html' => :'footer_html',
|
|
237
259
|
:'html_engine_options' => :'html_engine_options',
|
|
238
260
|
:'html_escape_data' => :'html_escape_data',
|
|
239
|
-
:'layout' => :'layout'
|
|
261
|
+
:'layout' => :'layout',
|
|
262
|
+
:'override_account_expiry' => :'override_account_expiry',
|
|
263
|
+
:'sync_fields' => :'sync_fields'
|
|
240
264
|
}
|
|
241
265
|
end
|
|
242
266
|
|
|
@@ -262,6 +286,7 @@ module DocSpring
|
|
|
262
286
|
:'ai_field_naming_language' => :'AiFieldNamingLanguage',
|
|
263
287
|
:'allow_additional_properties' => :'Boolean',
|
|
264
288
|
:'allow_skipping_optional_fields' => :'Boolean',
|
|
289
|
+
:'continue_before_optional_fields' => :'Boolean',
|
|
265
290
|
:'default_form_mode' => :'TemplateFormMode',
|
|
266
291
|
:'editable_submissions' => :'Boolean',
|
|
267
292
|
:'embed_domains' => :'Array<String>',
|
|
@@ -288,11 +313,14 @@ module DocSpring
|
|
|
288
313
|
:'success_title' => :'String',
|
|
289
314
|
:'success_message' => :'String',
|
|
290
315
|
:'show_fill_again_button' => :'Boolean',
|
|
316
|
+
:'form_sections_in_order' => :'Boolean',
|
|
291
317
|
:'slack_webhook_url' => :'String',
|
|
292
318
|
:'defaults' => :'TemplateDefaultsInput',
|
|
293
319
|
:'field_dependencies' => :'Array<TemplateFieldDependencyInput>',
|
|
294
320
|
:'field_groups' => :'Array<FieldGroupInput>',
|
|
295
321
|
:'form_sections' => :'Array<TemplateFormSectionInput>',
|
|
322
|
+
:'signer_roles' => :'Array<TemplateSignerRoleInput>',
|
|
323
|
+
:'signature_request_cc' => :'Array<String>',
|
|
296
324
|
:'predefined_fields' => :'Array<PredefinedFieldInput>',
|
|
297
325
|
:'predefined_fields_sample_data' => :'Hash<String, Object>',
|
|
298
326
|
:'html' => :'String',
|
|
@@ -301,7 +329,9 @@ module DocSpring
|
|
|
301
329
|
:'footer_html' => :'String',
|
|
302
330
|
:'html_engine_options' => :'HtmlEngineOptionsInput',
|
|
303
331
|
:'html_escape_data' => :'Boolean',
|
|
304
|
-
:'layout' => :'Hash<String, Object>'
|
|
332
|
+
:'layout' => :'Hash<String, Object>',
|
|
333
|
+
:'override_account_expiry' => :'Boolean',
|
|
334
|
+
:'sync_fields' => :'Boolean'
|
|
305
335
|
}
|
|
306
336
|
end
|
|
307
337
|
|
|
@@ -326,7 +356,7 @@ module DocSpring
|
|
|
326
356
|
:'header_html',
|
|
327
357
|
:'footer_html',
|
|
328
358
|
:'html_engine_options',
|
|
329
|
-
:'layout'
|
|
359
|
+
:'layout',
|
|
330
360
|
])
|
|
331
361
|
end
|
|
332
362
|
|
|
@@ -392,6 +422,10 @@ module DocSpring
|
|
|
392
422
|
self.allow_skipping_optional_fields = attributes[:'allow_skipping_optional_fields']
|
|
393
423
|
end
|
|
394
424
|
|
|
425
|
+
if attributes.key?(:'continue_before_optional_fields')
|
|
426
|
+
self.continue_before_optional_fields = attributes[:'continue_before_optional_fields']
|
|
427
|
+
end
|
|
428
|
+
|
|
395
429
|
if attributes.key?(:'default_form_mode')
|
|
396
430
|
self.default_form_mode = attributes[:'default_form_mode']
|
|
397
431
|
end
|
|
@@ -500,6 +534,10 @@ module DocSpring
|
|
|
500
534
|
self.show_fill_again_button = attributes[:'show_fill_again_button']
|
|
501
535
|
end
|
|
502
536
|
|
|
537
|
+
if attributes.key?(:'form_sections_in_order')
|
|
538
|
+
self.form_sections_in_order = attributes[:'form_sections_in_order']
|
|
539
|
+
end
|
|
540
|
+
|
|
503
541
|
if attributes.key?(:'slack_webhook_url')
|
|
504
542
|
self.slack_webhook_url = attributes[:'slack_webhook_url']
|
|
505
543
|
end
|
|
@@ -526,6 +564,18 @@ module DocSpring
|
|
|
526
564
|
end
|
|
527
565
|
end
|
|
528
566
|
|
|
567
|
+
if attributes.key?(:'signer_roles')
|
|
568
|
+
if (value = attributes[:'signer_roles']).is_a?(Array)
|
|
569
|
+
self.signer_roles = value
|
|
570
|
+
end
|
|
571
|
+
end
|
|
572
|
+
|
|
573
|
+
if attributes.key?(:'signature_request_cc')
|
|
574
|
+
if (value = attributes[:'signature_request_cc']).is_a?(Array)
|
|
575
|
+
self.signature_request_cc = value
|
|
576
|
+
end
|
|
577
|
+
end
|
|
578
|
+
|
|
529
579
|
if attributes.key?(:'predefined_fields')
|
|
530
580
|
if (value = attributes[:'predefined_fields']).is_a?(Array)
|
|
531
581
|
self.predefined_fields = value
|
|
@@ -567,6 +617,14 @@ module DocSpring
|
|
|
567
617
|
self.layout = value
|
|
568
618
|
end
|
|
569
619
|
end
|
|
620
|
+
|
|
621
|
+
if attributes.key?(:'override_account_expiry')
|
|
622
|
+
self.override_account_expiry = attributes[:'override_account_expiry']
|
|
623
|
+
end
|
|
624
|
+
|
|
625
|
+
if attributes.key?(:'sync_fields')
|
|
626
|
+
self.sync_fields = attributes[:'sync_fields']
|
|
627
|
+
end
|
|
570
628
|
end
|
|
571
629
|
|
|
572
630
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -608,6 +666,7 @@ module DocSpring
|
|
|
608
666
|
ai_field_naming_language == o.ai_field_naming_language &&
|
|
609
667
|
allow_additional_properties == o.allow_additional_properties &&
|
|
610
668
|
allow_skipping_optional_fields == o.allow_skipping_optional_fields &&
|
|
669
|
+
continue_before_optional_fields == o.continue_before_optional_fields &&
|
|
611
670
|
default_form_mode == o.default_form_mode &&
|
|
612
671
|
editable_submissions == o.editable_submissions &&
|
|
613
672
|
embed_domains == o.embed_domains &&
|
|
@@ -634,11 +693,14 @@ module DocSpring
|
|
|
634
693
|
success_title == o.success_title &&
|
|
635
694
|
success_message == o.success_message &&
|
|
636
695
|
show_fill_again_button == o.show_fill_again_button &&
|
|
696
|
+
form_sections_in_order == o.form_sections_in_order &&
|
|
637
697
|
slack_webhook_url == o.slack_webhook_url &&
|
|
638
698
|
defaults == o.defaults &&
|
|
639
699
|
field_dependencies == o.field_dependencies &&
|
|
640
700
|
field_groups == o.field_groups &&
|
|
641
701
|
form_sections == o.form_sections &&
|
|
702
|
+
signer_roles == o.signer_roles &&
|
|
703
|
+
signature_request_cc == o.signature_request_cc &&
|
|
642
704
|
predefined_fields == o.predefined_fields &&
|
|
643
705
|
predefined_fields_sample_data == o.predefined_fields_sample_data &&
|
|
644
706
|
html == o.html &&
|
|
@@ -647,7 +709,9 @@ module DocSpring
|
|
|
647
709
|
footer_html == o.footer_html &&
|
|
648
710
|
html_engine_options == o.html_engine_options &&
|
|
649
711
|
html_escape_data == o.html_escape_data &&
|
|
650
|
-
layout == o.layout
|
|
712
|
+
layout == o.layout &&
|
|
713
|
+
override_account_expiry == o.override_account_expiry &&
|
|
714
|
+
sync_fields == o.sync_fields
|
|
651
715
|
end
|
|
652
716
|
|
|
653
717
|
# @see the `==` method
|
|
@@ -659,7 +723,7 @@ module DocSpring
|
|
|
659
723
|
# Calculates hash code according to all attributes.
|
|
660
724
|
# @return [Integer] Hash code
|
|
661
725
|
def hash
|
|
662
|
-
[name, description, output_format, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, success_title, success_message, show_fill_again_button, slack_webhook_url, defaults, field_dependencies, field_groups, form_sections, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout].hash
|
|
726
|
+
[name, description, output_format, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, continue_before_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, success_title, success_message, show_fill_again_button, form_sections_in_order, slack_webhook_url, defaults, field_dependencies, field_groups, form_sections, signer_roles, signature_request_cc, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, override_account_expiry, sync_fields].hash
|
|
663
727
|
end
|
|
664
728
|
|
|
665
729
|
# Builds the object from hash
|
|
@@ -22,7 +22,7 @@ module DocSpring
|
|
|
22
22
|
# `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
|
|
23
23
|
attr_accessor :editable
|
|
24
24
|
|
|
25
|
-
# The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them
|
|
25
|
+
# The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them. Signatures come only from signature requests: a value for a signature or initials field makes the submission `invalid_data`, in test mode too. To print an image or a name you send, use an Image or Text field.
|
|
26
26
|
attr_accessor :data
|
|
27
27
|
|
|
28
28
|
# Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
|
|
@@ -31,10 +31,10 @@ module DocSpring
|
|
|
31
31
|
# A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
|
|
32
32
|
attr_accessor :password
|
|
33
33
|
|
|
34
|
-
# What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
34
|
+
# What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. A Word template's submission with signature requests makes only `pdf`, which its signers sign. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
35
35
|
attr_accessor :output_formats
|
|
36
36
|
|
|
37
|
-
# Seconds after the
|
|
37
|
+
# Seconds after the submission is processed until it expires, up to 10 years (315360000), sooner or later than the template's or the account's expiry setting. Defaults to the template's expiry when it overrides the account's (`override_account_expiry`), and otherwise to the account's expiry setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
|
|
38
38
|
attr_accessor :expires_in
|
|
39
39
|
|
|
40
40
|
# Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. A `default` for a signature or initials field makes the submission `invalid_data`. With `signature_requests`, `editable: true` is a 422.
|
|
@@ -46,7 +46,7 @@ module DocSpring
|
|
|
46
46
|
# For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity.
|
|
47
47
|
attr_accessor :css
|
|
48
48
|
|
|
49
|
-
# The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF
|
|
49
|
+
# The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. The signers of an HTML template, a Word template or a page design fill in its form fields and signature tags in a PDF made from `data`, and a Word template's submission makes only a PDF. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out.
|
|
50
50
|
attr_accessor :signature_requests
|
|
51
51
|
|
|
52
52
|
# Whether DocSpring emails the signers their signing links, and sends the reminders and the completed document. Default true. Each signature request's own `send_email` overrides it. A test submission only emails your DocSpring team: every other address is a 422. `true` needs `signature_requests`. DocSpring doesn't email the signers of a form library template: leave `send_email` out, and send them their links yourself.
|
|
@@ -61,7 +61,7 @@ module DocSpring
|
|
|
61
61
|
# A message for the people who sign, shown above the signing button. It takes the same variables as `email_subject`. Links and web addresses are shown as plain text. Leave it out for none: a blank message is a 422.
|
|
62
62
|
attr_accessor :email_message
|
|
63
63
|
|
|
64
|
-
# People who get a copy of the completed document
|
|
64
|
+
# People who get a copy of the completed document, as well as the template's `signature_request_cc`. They don't sign.
|
|
65
65
|
attr_accessor :cc
|
|
66
66
|
|
|
67
67
|
# Where replies to the emails go: a member of your DocSpring team, or an address at one of your verified email domains. Leave it out for the template's reply-to address (the account owner when it has none).
|