docspring 4.1.0 → 4.3.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/.openapi-generator/FILES +15 -0
- data/.travis.yml +1 -1
- data/AGENTS.md +5 -4
- data/CHANGELOG.md +67 -0
- data/Gemfile.lock +11 -10
- data/README.md +11 -6
- data/docs/Client.md +273 -105
- data/docs/CombinedPdf.md +1 -1
- data/docs/CreateCombinedPdfRequest.md +1 -1
- data/docs/CreateSubmissionRequest.md +5 -5
- data/docs/CreateTemplatePreviewRequest.md +18 -0
- data/docs/CreateTemplateRequest.md +14 -10
- data/docs/ErrorDetail.md +1 -1
- data/docs/ErrorInfo.md +4 -4
- data/docs/FieldGroup.md +2 -2
- data/docs/FieldGroupInput.md +1 -1
- data/docs/GenerateSubmissionFilesRequest.md +1 -1
- data/docs/GeneratedFile.md +2 -2
- data/docs/Submission.md +18 -18
- data/docs/SubmissionBatch.md +3 -3
- data/docs/SubmissionFiles.md +4 -0
- data/docs/SubmissionInput.md +5 -5
- data/docs/SubmissionList.md +1 -1
- data/docs/SubmissionSummary.md +54 -0
- data/docs/Template.md +21 -17
- data/docs/TemplateActor.md +1 -1
- data/docs/TemplateDiff.md +2 -2
- data/docs/TemplateDocument.md +12 -12
- data/docs/TemplateDocumentSummary.md +24 -0
- data/docs/TemplatePreview.md +32 -0
- data/docs/TemplatePreviewState.md +15 -0
- data/docs/TemplateSummary.md +5 -49
- data/docs/UpdateTemplateDocumentRequest.md +5 -5
- data/docs/UpdateTemplateRequest.md +10 -6
- data/docs/ValidateSubmissionRequest.md +5 -5
- data/docspring.gemspec +2 -2
- data/lib/docspring/api/client.rb +222 -49
- data/lib/docspring/api_client.rb +5 -3
- data/lib/docspring/api_error.rb +1 -1
- data/lib/docspring/api_model_base.rb +1 -1
- data/lib/docspring/configuration.rb +1 -1
- data/lib/docspring/date_time_values.rb +33 -0
- data/lib/docspring/models/add_template_fields_request.rb +1 -1
- data/lib/docspring/models/ai_field_naming_language.rb +1 -1
- data/lib/docspring/models/authentication_check.rb +1 -1
- data/lib/docspring/models/barcode_symbology.rb +1 -1
- data/lib/docspring/models/check_character.rb +1 -1
- data/lib/docspring/models/combined_field_type.rb +1 -1
- data/lib/docspring/models/combined_pdf.rb +2 -2
- data/lib/docspring/models/combined_pdf_files.rb +1 -1
- data/lib/docspring/models/combined_pdf_list.rb +1 -1
- data/lib/docspring/models/combined_pdf_source.rb +1 -1
- data/lib/docspring/models/combined_pdf_source_input.rb +1 -1
- data/lib/docspring/models/combined_pdf_source_pdf.rb +1 -1
- data/lib/docspring/models/combined_pdf_source_type.rb +1 -1
- data/lib/docspring/models/combined_pdf_state.rb +1 -1
- data/lib/docspring/models/copy_template_request.rb +1 -1
- data/lib/docspring/models/create_combined_pdf_request.rb +2 -2
- data/lib/docspring/models/create_custom_file_from_upload_request.rb +1 -1
- data/lib/docspring/models/create_folder_request.rb +1 -1
- data/lib/docspring/models/create_signature_request_event_request.rb +1 -1
- data/lib/docspring/models/create_signature_request_token_request.rb +1 -1
- data/lib/docspring/models/create_submission_batch_request.rb +1 -1
- data/lib/docspring/models/create_submission_request.rb +6 -6
- data/lib/docspring/models/create_template_preview_request.rb +187 -0
- data/lib/docspring/models/create_template_request.rb +32 -12
- data/lib/docspring/models/create_webhook_request.rb +1 -1
- data/lib/docspring/models/custom_file.rb +1 -1
- data/lib/docspring/models/custom_file_list.rb +1 -1
- data/lib/docspring/models/custom_file_source_pdf.rb +1 -1
- data/lib/docspring/models/error_code.rb +4 -2
- data/lib/docspring/models/error_detail.rb +2 -2
- data/lib/docspring/models/error_info.rb +5 -5
- data/lib/docspring/models/error_response.rb +1 -1
- data/lib/docspring/models/expiration_interval.rb +1 -1
- data/lib/docspring/models/field.rb +2 -2
- data/lib/docspring/models/field_comparison_condition.rb +1 -1
- data/lib/docspring/models/field_comparison_operator.rb +1 -1
- data/lib/docspring/models/field_dependency.rb +1 -1
- data/lib/docspring/models/field_dependency_input.rb +1 -1
- data/lib/docspring/models/field_display_type.rb +1 -1
- data/lib/docspring/models/field_equals_condition.rb +1 -1
- data/lib/docspring/models/field_equals_operator.rb +1 -1
- data/lib/docspring/models/field_group.rb +3 -3
- data/lib/docspring/models/field_group_input.rb +2 -2
- data/lib/docspring/models/field_group_type.rb +1 -1
- data/lib/docspring/models/field_in_condition.rb +1 -1
- data/lib/docspring/models/field_input.rb +2 -2
- data/lib/docspring/models/field_override.rb +1 -1
- data/lib/docspring/models/field_presence_condition.rb +1 -1
- data/lib/docspring/models/field_presence_operator.rb +1 -1
- data/lib/docspring/models/field_range_condition.rb +1 -1
- data/lib/docspring/models/field_reimport_state.rb +1 -1
- data/lib/docspring/models/field_setup_logic.rb +1 -1
- data/lib/docspring/models/field_setup_naming.rb +1 -1
- data/lib/docspring/models/field_setup_source.rb +1 -1
- data/lib/docspring/models/field_type.rb +1 -1
- data/lib/docspring/models/folder.rb +1 -1
- data/lib/docspring/models/folder_list.rb +1 -1
- data/lib/docspring/models/generate_files_format.rb +5 -2
- data/lib/docspring/models/generate_submission_files_request.rb +2 -2
- data/lib/docspring/models/generated_file.rb +4 -4
- data/lib/docspring/models/generated_file_state.rb +1 -1
- data/lib/docspring/models/html_engine_options.rb +1 -1
- data/lib/docspring/models/html_engine_options_input.rb +1 -1
- data/lib/docspring/models/image_gravity.rb +1 -1
- data/lib/docspring/models/image_scale_type.rb +1 -1
- data/lib/docspring/models/model_code_language.rb +3 -2
- data/lib/docspring/models/move_folder_request.rb +1 -1
- data/lib/docspring/models/move_template_request.rb +1 -1
- data/lib/docspring/models/number_condition_type.rb +1 -1
- data/lib/docspring/models/output_format.rb +4 -2
- data/lib/docspring/models/page_format.rb +1 -1
- data/lib/docspring/models/page_image.rb +1 -1
- data/lib/docspring/models/page_images.rb +1 -1
- data/lib/docspring/models/predefined_field.rb +1 -1
- data/lib/docspring/models/predefined_field_input.rb +1 -1
- data/lib/docspring/models/publish_template_version_request.rb +1 -1
- data/lib/docspring/models/remove_template_fields_request.rb +1 -1
- data/lib/docspring/models/rename_folder_request.rb +1 -1
- data/lib/docspring/models/reorder_template_fields_request.rb +1 -1
- data/lib/docspring/models/restore_template_version_request.rb +1 -1
- data/lib/docspring/models/shape_type.rb +1 -1
- data/lib/docspring/models/signature_request.rb +1 -1
- data/lib/docspring/models/signature_request_auth_second_factor_type.rb +1 -1
- data/lib/docspring/models/signature_request_auth_type.rb +1 -1
- data/lib/docspring/models/signature_request_event.rb +1 -1
- data/lib/docspring/models/signature_request_event_type.rb +1 -1
- data/lib/docspring/models/signature_request_input.rb +1 -1
- data/lib/docspring/models/signature_request_message_type.rb +1 -1
- data/lib/docspring/models/signature_request_state.rb +1 -1
- data/lib/docspring/models/signature_request_token.rb +1 -1
- data/lib/docspring/models/signature_request_token_type.rb +1 -1
- data/lib/docspring/models/string_condition_type.rb +1 -1
- data/lib/docspring/models/submission.rb +145 -145
- data/lib/docspring/models/submission_action.rb +1 -1
- data/lib/docspring/models/submission_action_state.rb +1 -1
- data/lib/docspring/models/submission_action_type.rb +1 -1
- data/lib/docspring/models/submission_batch.rb +5 -5
- data/lib/docspring/models/submission_batch_state.rb +1 -1
- data/lib/docspring/models/submission_files.rb +22 -2
- data/lib/docspring/models/submission_input.rb +6 -6
- data/lib/docspring/models/submission_list.rb +2 -2
- data/lib/docspring/models/submission_source.rb +1 -1
- data/lib/docspring/models/submission_source_pdf.rb +1 -1
- data/lib/docspring/models/submission_state.rb +1 -1
- data/lib/docspring/models/submission_summary.rb +601 -0
- data/lib/docspring/models/submission_validation.rb +1 -1
- data/lib/docspring/models/template.rb +131 -91
- data/lib/docspring/models/template_actor.rb +2 -2
- data/lib/docspring/models/template_actor_type.rb +1 -1
- data/lib/docspring/models/template_defaults.rb +1 -1
- data/lib/docspring/models/template_defaults_input.rb +1 -1
- data/lib/docspring/models/template_diff.rb +3 -3
- data/lib/docspring/models/template_diff_summary.rb +1 -1
- data/lib/docspring/models/template_document.rb +51 -51
- data/lib/docspring/models/template_document_state.rb +4 -2
- data/lib/docspring/models/template_document_summary.rb +260 -0
- data/lib/docspring/models/template_field_change.rb +1 -1
- data/lib/docspring/models/template_field_changes.rb +1 -1
- data/lib/docspring/models/template_field_dependency.rb +1 -1
- data/lib/docspring/models/template_field_dependency_action.rb +1 -1
- data/lib/docspring/models/template_field_dependency_condition.rb +1 -1
- data/lib/docspring/models/template_field_dependency_condition_input.rb +1 -1
- data/lib/docspring/models/template_field_dependency_input.rb +1 -1
- data/lib/docspring/models/template_field_dependency_match.rb +1 -1
- data/lib/docspring/models/template_field_dependency_operator.rb +1 -1
- data/lib/docspring/models/template_field_logic_status.rb +1 -1
- data/lib/docspring/models/template_field_move.rb +1 -1
- data/lib/docspring/models/template_fields.rb +1 -1
- data/lib/docspring/models/template_form_mode.rb +1 -1
- data/lib/docspring/models/template_model_code.rb +1 -1
- data/lib/docspring/models/template_page_ai_error.rb +1 -1
- data/lib/docspring/models/template_page_ai_naming_status.rb +1 -1
- data/lib/docspring/models/template_page_fields_status.rb +1 -1
- data/lib/docspring/models/template_page_image_status.rb +1 -1
- data/lib/docspring/models/template_page_images.rb +1 -1
- data/lib/docspring/models/template_page_processing_status.rb +1 -1
- data/lib/docspring/models/template_preview.rb +356 -0
- data/lib/docspring/models/template_preview_state.rb +42 -0
- data/lib/docspring/models/template_source_pdf.rb +1 -1
- data/lib/docspring/models/template_summary.rb +34 -574
- data/lib/docspring/models/template_summary_list.rb +1 -1
- data/lib/docspring/models/template_type.rb +3 -2
- data/lib/docspring/models/template_version.rb +1 -1
- data/lib/docspring/models/template_version_type.rb +1 -1
- data/lib/docspring/models/text_alignment.rb +1 -1
- data/lib/docspring/models/text_overflow.rb +1 -1
- data/lib/docspring/models/text_vertical_alignment.rb +1 -1
- data/lib/docspring/models/typeface.rb +1 -1
- data/lib/docspring/models/update_signature_request_request.rb +1 -1
- data/lib/docspring/models/update_template_document_request.rb +7 -7
- data/lib/docspring/models/update_template_fields_request.rb +1 -1
- data/lib/docspring/models/update_template_request.rb +31 -11
- data/lib/docspring/models/update_webhook_request.rb +1 -1
- data/lib/docspring/models/upload_method.rb +1 -1
- data/lib/docspring/models/upload_presign.rb +1 -1
- data/lib/docspring/models/url_source_pdf.rb +1 -1
- data/lib/docspring/models/validate_submission_request.rb +6 -6
- data/lib/docspring/models/webhook.rb +1 -1
- data/lib/docspring/models/webhook_event_type.rb +1 -1
- data/lib/docspring/models/webhook_list.rb +1 -1
- data/lib/docspring/models/webhook_mode.rb +1 -1
- data/lib/docspring/request_schemas.json +144 -10
- data/lib/docspring/version.rb +2 -2
- data/lib/docspring/webhook_signature.rb +45 -0
- data/lib/docspring.rb +7 -1
- data/spec/api/client_spec.rb +61 -25
- data/spec/models/add_template_fields_request_spec.rb +1 -1
- data/spec/models/ai_field_naming_language_spec.rb +1 -1
- data/spec/models/authentication_check_spec.rb +1 -1
- data/spec/models/barcode_symbology_spec.rb +1 -1
- data/spec/models/check_character_spec.rb +1 -1
- data/spec/models/combined_field_type_spec.rb +1 -1
- data/spec/models/combined_pdf_files_spec.rb +1 -1
- data/spec/models/combined_pdf_list_spec.rb +1 -1
- data/spec/models/combined_pdf_source_input_spec.rb +1 -1
- data/spec/models/combined_pdf_source_pdf_spec.rb +1 -1
- data/spec/models/combined_pdf_source_spec.rb +1 -1
- data/spec/models/combined_pdf_source_type_spec.rb +1 -1
- data/spec/models/combined_pdf_spec.rb +1 -1
- data/spec/models/combined_pdf_state_spec.rb +1 -1
- data/spec/models/copy_template_request_spec.rb +1 -1
- data/spec/models/create_combined_pdf_request_spec.rb +1 -1
- data/spec/models/create_custom_file_from_upload_request_spec.rb +1 -1
- data/spec/models/create_folder_request_spec.rb +1 -1
- data/spec/models/create_signature_request_event_request_spec.rb +1 -1
- data/spec/models/create_signature_request_token_request_spec.rb +1 -1
- data/spec/models/create_submission_batch_request_spec.rb +1 -1
- data/spec/models/create_submission_request_spec.rb +1 -1
- data/spec/models/create_template_preview_request_spec.rb +36 -0
- data/spec/models/create_template_request_spec.rb +13 -1
- data/spec/models/create_webhook_request_spec.rb +1 -1
- data/spec/models/custom_file_list_spec.rb +1 -1
- data/spec/models/custom_file_source_pdf_spec.rb +1 -1
- data/spec/models/custom_file_spec.rb +1 -1
- data/spec/models/error_code_spec.rb +1 -1
- data/spec/models/error_detail_spec.rb +1 -1
- data/spec/models/error_info_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/expiration_interval_spec.rb +1 -1
- data/spec/models/field_comparison_condition_spec.rb +1 -1
- data/spec/models/field_comparison_operator_spec.rb +1 -1
- data/spec/models/field_dependency_input_spec.rb +1 -1
- data/spec/models/field_dependency_spec.rb +1 -1
- data/spec/models/field_display_type_spec.rb +1 -1
- data/spec/models/field_equals_condition_spec.rb +1 -1
- data/spec/models/field_equals_operator_spec.rb +1 -1
- data/spec/models/field_group_input_spec.rb +1 -1
- data/spec/models/field_group_spec.rb +1 -1
- data/spec/models/field_group_type_spec.rb +1 -1
- data/spec/models/field_in_condition_spec.rb +1 -1
- data/spec/models/field_input_spec.rb +1 -1
- data/spec/models/field_override_spec.rb +1 -1
- data/spec/models/field_presence_condition_spec.rb +1 -1
- data/spec/models/field_presence_operator_spec.rb +1 -1
- data/spec/models/field_range_condition_spec.rb +1 -1
- data/spec/models/field_reimport_state_spec.rb +1 -1
- data/spec/models/field_setup_logic_spec.rb +1 -1
- data/spec/models/field_setup_naming_spec.rb +1 -1
- data/spec/models/field_setup_source_spec.rb +1 -1
- data/spec/models/field_spec.rb +1 -1
- data/spec/models/field_type_spec.rb +1 -1
- data/spec/models/folder_list_spec.rb +1 -1
- data/spec/models/folder_spec.rb +1 -1
- data/spec/models/generate_files_format_spec.rb +1 -1
- data/spec/models/generate_submission_files_request_spec.rb +1 -1
- data/spec/models/generated_file_spec.rb +1 -1
- data/spec/models/generated_file_state_spec.rb +1 -1
- data/spec/models/html_engine_options_input_spec.rb +1 -1
- data/spec/models/html_engine_options_spec.rb +1 -1
- data/spec/models/image_gravity_spec.rb +1 -1
- data/spec/models/image_scale_type_spec.rb +1 -1
- data/spec/models/model_code_language_spec.rb +1 -1
- data/spec/models/move_folder_request_spec.rb +1 -1
- data/spec/models/move_template_request_spec.rb +1 -1
- data/spec/models/number_condition_type_spec.rb +1 -1
- data/spec/models/output_format_spec.rb +1 -1
- data/spec/models/page_format_spec.rb +1 -1
- data/spec/models/page_image_spec.rb +1 -1
- data/spec/models/page_images_spec.rb +1 -1
- data/spec/models/predefined_field_input_spec.rb +1 -1
- data/spec/models/predefined_field_spec.rb +1 -1
- data/spec/models/publish_template_version_request_spec.rb +1 -1
- data/spec/models/remove_template_fields_request_spec.rb +1 -1
- data/spec/models/rename_folder_request_spec.rb +1 -1
- data/spec/models/reorder_template_fields_request_spec.rb +1 -1
- data/spec/models/restore_template_version_request_spec.rb +1 -1
- data/spec/models/shape_type_spec.rb +1 -1
- data/spec/models/signature_request_auth_second_factor_type_spec.rb +1 -1
- data/spec/models/signature_request_auth_type_spec.rb +1 -1
- data/spec/models/signature_request_event_spec.rb +1 -1
- data/spec/models/signature_request_event_type_spec.rb +1 -1
- data/spec/models/signature_request_input_spec.rb +1 -1
- data/spec/models/signature_request_message_type_spec.rb +1 -1
- data/spec/models/signature_request_spec.rb +1 -1
- data/spec/models/signature_request_state_spec.rb +1 -1
- data/spec/models/signature_request_token_spec.rb +1 -1
- data/spec/models/signature_request_token_type_spec.rb +1 -1
- data/spec/models/string_condition_type_spec.rb +1 -1
- data/spec/models/submission_action_spec.rb +1 -1
- data/spec/models/submission_action_state_spec.rb +1 -1
- data/spec/models/submission_action_type_spec.rb +1 -1
- data/spec/models/submission_batch_spec.rb +1 -1
- data/spec/models/submission_batch_state_spec.rb +1 -1
- data/spec/models/submission_files_spec.rb +13 -1
- data/spec/models/submission_input_spec.rb +1 -1
- data/spec/models/submission_list_spec.rb +1 -1
- data/spec/models/submission_source_pdf_spec.rb +1 -1
- data/spec/models/submission_source_spec.rb +1 -1
- data/spec/models/submission_spec.rb +13 -13
- data/spec/models/submission_state_spec.rb +1 -1
- data/spec/models/submission_summary_spec.rb +144 -0
- data/spec/models/submission_validation_spec.rb +1 -1
- data/spec/models/template_actor_spec.rb +1 -1
- data/spec/models/template_actor_type_spec.rb +1 -1
- data/spec/models/template_defaults_input_spec.rb +1 -1
- data/spec/models/template_defaults_spec.rb +1 -1
- data/spec/models/template_diff_spec.rb +1 -1
- data/spec/models/template_diff_summary_spec.rb +1 -1
- data/spec/models/template_document_spec.rb +6 -6
- data/spec/models/template_document_state_spec.rb +1 -1
- data/spec/models/template_document_summary_spec.rb +54 -0
- data/spec/models/template_field_change_spec.rb +1 -1
- data/spec/models/template_field_changes_spec.rb +1 -1
- data/spec/models/template_field_dependency_action_spec.rb +1 -1
- data/spec/models/template_field_dependency_condition_input_spec.rb +1 -1
- data/spec/models/template_field_dependency_condition_spec.rb +1 -1
- data/spec/models/template_field_dependency_input_spec.rb +1 -1
- data/spec/models/template_field_dependency_match_spec.rb +1 -1
- data/spec/models/template_field_dependency_operator_spec.rb +1 -1
- data/spec/models/template_field_dependency_spec.rb +1 -1
- data/spec/models/template_field_logic_status_spec.rb +1 -1
- data/spec/models/template_field_move_spec.rb +1 -1
- data/spec/models/template_fields_spec.rb +1 -1
- data/spec/models/template_form_mode_spec.rb +1 -1
- data/spec/models/template_model_code_spec.rb +1 -1
- data/spec/models/template_page_ai_error_spec.rb +1 -1
- data/spec/models/template_page_ai_naming_status_spec.rb +1 -1
- data/spec/models/template_page_fields_status_spec.rb +1 -1
- data/spec/models/template_page_image_status_spec.rb +1 -1
- data/spec/models/template_page_images_spec.rb +1 -1
- data/spec/models/template_page_processing_status_spec.rb +1 -1
- data/spec/models/template_preview_spec.rb +78 -0
- data/spec/models/template_preview_state_spec.rb +30 -0
- data/spec/models/template_source_pdf_spec.rb +1 -1
- data/spec/models/template_spec.rb +35 -23
- data/spec/models/template_summary_list_spec.rb +1 -1
- data/spec/models/template_summary_spec.rb +6 -138
- data/spec/models/template_type_spec.rb +1 -1
- data/spec/models/template_version_spec.rb +1 -1
- data/spec/models/template_version_type_spec.rb +1 -1
- data/spec/models/text_alignment_spec.rb +1 -1
- data/spec/models/text_overflow_spec.rb +1 -1
- data/spec/models/text_vertical_alignment_spec.rb +1 -1
- data/spec/models/typeface_spec.rb +1 -1
- data/spec/models/update_signature_request_request_spec.rb +1 -1
- data/spec/models/update_template_document_request_spec.rb +1 -1
- data/spec/models/update_template_fields_request_spec.rb +1 -1
- data/spec/models/update_template_request_spec.rb +13 -1
- data/spec/models/update_webhook_request_spec.rb +1 -1
- data/spec/models/upload_method_spec.rb +1 -1
- data/spec/models/upload_presign_spec.rb +1 -1
- data/spec/models/url_source_pdf_spec.rb +1 -1
- data/spec/models/validate_submission_request_spec.rb +1 -1
- data/spec/models/webhook_event_type_spec.rb +1 -1
- data/spec/models/webhook_list_spec.rb +1 -1
- data/spec/models/webhook_mode_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +25 -2
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
@@ -25,13 +25,16 @@ module DocSpring
|
|
|
25
25
|
# Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests.
|
|
26
26
|
attr_accessor :description
|
|
27
27
|
|
|
28
|
-
# `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
|
|
28
|
+
# `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
|
|
29
29
|
attr_accessor :template_type
|
|
30
30
|
|
|
31
|
-
#
|
|
31
|
+
# What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
|
|
32
|
+
attr_accessor :output_format
|
|
33
|
+
|
|
34
|
+
# Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded).
|
|
32
35
|
attr_accessor :ready
|
|
33
36
|
|
|
34
|
-
# The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet.
|
|
37
|
+
# The PDF of a PDF template, or the Word document of a Word template. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url` has one, with no file, while it's downloaded.
|
|
35
38
|
attr_accessor :document
|
|
36
39
|
|
|
37
40
|
# The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions.
|
|
@@ -40,9 +43,6 @@ module DocSpring
|
|
|
40
43
|
# The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root.
|
|
41
44
|
attr_accessor :path
|
|
42
45
|
|
|
43
|
-
# The published version this is, such as `1.2.0`. Null for the draft.
|
|
44
|
-
attr_accessor :version
|
|
45
|
-
|
|
46
46
|
# The template's latest published version. Null if no version has been published.
|
|
47
47
|
attr_accessor :latest_version
|
|
48
48
|
|
|
@@ -52,6 +52,18 @@ module DocSpring
|
|
|
52
52
|
# A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed).
|
|
53
53
|
attr_accessor :locked
|
|
54
54
|
|
|
55
|
+
# When the draft was last changed.
|
|
56
|
+
attr_accessor :last_changed_at
|
|
57
|
+
|
|
58
|
+
# When the template was created.
|
|
59
|
+
attr_accessor :created_at
|
|
60
|
+
|
|
61
|
+
# When the template was last updated.
|
|
62
|
+
attr_accessor :updated_at
|
|
63
|
+
|
|
64
|
+
# The published version this is, such as `1.2.0`. Null for the draft.
|
|
65
|
+
attr_accessor :version
|
|
66
|
+
|
|
55
67
|
# Print the submission ID in the footer of each page of PDFs signed through signature requests.
|
|
56
68
|
attr_accessor :add_signature_request_submission_id_footers
|
|
57
69
|
|
|
@@ -64,13 +76,13 @@ module DocSpring
|
|
|
64
76
|
# Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it.
|
|
65
77
|
attr_accessor :allow_skipping_optional_fields
|
|
66
78
|
|
|
67
|
-
# 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).
|
|
79
|
+
# 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`.
|
|
68
80
|
attr_accessor :default_form_mode
|
|
69
81
|
|
|
70
82
|
# Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
|
|
71
83
|
attr_accessor :editable_submissions
|
|
72
84
|
|
|
73
|
-
# The sites
|
|
85
|
+
# The sites that can embed the template's live signature requests and its embedded template editor: 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). 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. Forms embedded on a page (Visual Forms JS and the simple form) aren't restricted.
|
|
74
86
|
attr_accessor :embed_domains
|
|
75
87
|
|
|
76
88
|
# Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
|
|
@@ -82,7 +94,7 @@ module DocSpring
|
|
|
82
94
|
# Allow the embedded template editor to replace the template's PDF.
|
|
83
95
|
attr_accessor :embed_edit_allow_document_replacement
|
|
84
96
|
|
|
85
|
-
# Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
97
|
+
# Encrypt generated PDFs with `encrypt_pdfs_password`. A Word template can only encrypt its PDFs when its `output_format` is `pdf`, because Word documents and OpenDocument files can't be password-protected.
|
|
86
98
|
attr_accessor :encrypt_pdfs
|
|
87
99
|
|
|
88
100
|
# Whether `encrypt_pdfs_password` is set.
|
|
@@ -100,7 +112,7 @@ module DocSpring
|
|
|
100
112
|
# Add the audit trail to the end of PDFs signed through signature requests.
|
|
101
113
|
attr_accessor :merge_audit_trail_pdf
|
|
102
114
|
|
|
103
|
-
# Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
115
|
+
# Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML or Word template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
104
116
|
attr_accessor :parse_dates_using_template_date_format
|
|
105
117
|
|
|
106
118
|
# Allow anyone with a submission's ID to download its PDF.
|
|
@@ -115,18 +127,9 @@ module DocSpring
|
|
|
115
127
|
# Whether `slack_webhook_url` is set.
|
|
116
128
|
attr_accessor :has_slack_webhook_url
|
|
117
129
|
|
|
118
|
-
# When the draft was last changed.
|
|
119
|
-
attr_accessor :last_changed_at
|
|
120
|
-
|
|
121
130
|
# Who last changed the draft: a user in your account, an API token, or someone using the embedded template editor. Null if no change has been recorded.
|
|
122
131
|
attr_accessor :last_changed_by
|
|
123
132
|
|
|
124
|
-
# When the template was created.
|
|
125
|
-
attr_accessor :created_at
|
|
126
|
-
|
|
127
|
-
# When the template was last updated.
|
|
128
|
-
attr_accessor :updated_at
|
|
129
|
-
|
|
130
133
|
attr_accessor :defaults
|
|
131
134
|
|
|
132
135
|
# Conditional logic: each rule shows or hides its target fields, or makes them required, depending on the values of other fields.
|
|
@@ -141,7 +144,7 @@ module DocSpring
|
|
|
141
144
|
# Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for.
|
|
142
145
|
attr_accessor :predefined_fields_sample_data
|
|
143
146
|
|
|
144
|
-
# The HTML of an HTML template, as a Liquid template. Null for PDF templates.
|
|
147
|
+
# The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
|
|
145
148
|
attr_accessor :html
|
|
146
149
|
|
|
147
150
|
# The SCSS of an HTML template.
|
|
@@ -153,9 +156,12 @@ module DocSpring
|
|
|
153
156
|
# The HTML printed at the bottom of each page of an HTML template.
|
|
154
157
|
attr_accessor :footer_html
|
|
155
158
|
|
|
156
|
-
# How an HTML template's PDFs are printed. Null for PDF templates. Setting it replaces the whole object: options left out use their defaults.
|
|
159
|
+
# How an HTML template's PDFs are printed. Null for PDF and Word templates. Setting it replaces the whole object: options left out use their defaults.
|
|
157
160
|
attr_accessor :html_engine_options
|
|
158
161
|
|
|
162
|
+
# Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for PDF templates.
|
|
163
|
+
attr_accessor :html_escape_data
|
|
164
|
+
|
|
159
165
|
# The token that opens the template in the embedded template editor.
|
|
160
166
|
attr_accessor :embed_edit_token
|
|
161
167
|
|
|
@@ -191,14 +197,18 @@ module DocSpring
|
|
|
191
197
|
:'name' => :'name',
|
|
192
198
|
:'description' => :'description',
|
|
193
199
|
:'template_type' => :'template_type',
|
|
200
|
+
:'output_format' => :'output_format',
|
|
194
201
|
:'ready' => :'ready',
|
|
195
202
|
:'document' => :'document',
|
|
196
203
|
:'parent_folder_id' => :'parent_folder_id',
|
|
197
204
|
:'path' => :'path',
|
|
198
|
-
:'version' => :'version',
|
|
199
205
|
:'latest_version' => :'latest_version',
|
|
200
206
|
:'version_published_at' => :'version_published_at',
|
|
201
207
|
:'locked' => :'locked',
|
|
208
|
+
:'last_changed_at' => :'last_changed_at',
|
|
209
|
+
:'created_at' => :'created_at',
|
|
210
|
+
:'updated_at' => :'updated_at',
|
|
211
|
+
:'version' => :'version',
|
|
202
212
|
:'add_signature_request_submission_id_footers' => :'add_signature_request_submission_id_footers',
|
|
203
213
|
:'ai_field_naming_language' => :'ai_field_naming_language',
|
|
204
214
|
:'allow_additional_properties' => :'allow_additional_properties',
|
|
@@ -220,10 +230,7 @@ module DocSpring
|
|
|
220
230
|
:'public_web_form' => :'public_web_form',
|
|
221
231
|
:'redirect_url' => :'redirect_url',
|
|
222
232
|
:'has_slack_webhook_url' => :'has_slack_webhook_url',
|
|
223
|
-
:'last_changed_at' => :'last_changed_at',
|
|
224
233
|
:'last_changed_by' => :'last_changed_by',
|
|
225
|
-
:'created_at' => :'created_at',
|
|
226
|
-
:'updated_at' => :'updated_at',
|
|
227
234
|
:'defaults' => :'defaults',
|
|
228
235
|
:'field_dependencies' => :'field_dependencies',
|
|
229
236
|
:'field_groups' => :'field_groups',
|
|
@@ -234,6 +241,7 @@ module DocSpring
|
|
|
234
241
|
:'header_html' => :'header_html',
|
|
235
242
|
:'footer_html' => :'footer_html',
|
|
236
243
|
:'html_engine_options' => :'html_engine_options',
|
|
244
|
+
:'html_escape_data' => :'html_escape_data',
|
|
237
245
|
:'embed_edit_token' => :'embed_edit_token',
|
|
238
246
|
:'versions' => :'versions'
|
|
239
247
|
}
|
|
@@ -256,14 +264,18 @@ module DocSpring
|
|
|
256
264
|
:'name' => :'String',
|
|
257
265
|
:'description' => :'String',
|
|
258
266
|
:'template_type' => :'TemplateType',
|
|
267
|
+
:'output_format' => :'OutputFormat',
|
|
259
268
|
:'ready' => :'Boolean',
|
|
260
269
|
:'document' => :'TemplateDocument',
|
|
261
270
|
:'parent_folder_id' => :'String',
|
|
262
271
|
:'path' => :'String',
|
|
263
|
-
:'version' => :'String',
|
|
264
272
|
:'latest_version' => :'String',
|
|
265
273
|
:'version_published_at' => :'Time',
|
|
266
274
|
:'locked' => :'Boolean',
|
|
275
|
+
:'last_changed_at' => :'Time',
|
|
276
|
+
:'created_at' => :'Time',
|
|
277
|
+
:'updated_at' => :'Time',
|
|
278
|
+
:'version' => :'String',
|
|
267
279
|
:'add_signature_request_submission_id_footers' => :'Boolean',
|
|
268
280
|
:'ai_field_naming_language' => :'AiFieldNamingLanguage',
|
|
269
281
|
:'allow_additional_properties' => :'Boolean',
|
|
@@ -285,10 +297,7 @@ module DocSpring
|
|
|
285
297
|
:'public_web_form' => :'Boolean',
|
|
286
298
|
:'redirect_url' => :'String',
|
|
287
299
|
:'has_slack_webhook_url' => :'Boolean',
|
|
288
|
-
:'last_changed_at' => :'Time',
|
|
289
300
|
:'last_changed_by' => :'TemplateActor',
|
|
290
|
-
:'created_at' => :'Time',
|
|
291
|
-
:'updated_at' => :'Time',
|
|
292
301
|
:'defaults' => :'TemplateDefaults',
|
|
293
302
|
:'field_dependencies' => :'Array<TemplateFieldDependency>',
|
|
294
303
|
:'field_groups' => :'Array<FieldGroup>',
|
|
@@ -299,6 +308,7 @@ module DocSpring
|
|
|
299
308
|
:'header_html' => :'String',
|
|
300
309
|
:'footer_html' => :'String',
|
|
301
310
|
:'html_engine_options' => :'HtmlEngineOptions',
|
|
311
|
+
:'html_escape_data' => :'Boolean',
|
|
302
312
|
:'embed_edit_token' => :'String',
|
|
303
313
|
:'versions' => :'Array<TemplateVersion>'
|
|
304
314
|
}
|
|
@@ -311,12 +321,12 @@ module DocSpring
|
|
|
311
321
|
:'description',
|
|
312
322
|
:'document',
|
|
313
323
|
:'parent_folder_id',
|
|
314
|
-
:'version',
|
|
315
324
|
:'latest_version',
|
|
316
325
|
:'version_published_at',
|
|
326
|
+
:'last_changed_at',
|
|
327
|
+
:'version',
|
|
317
328
|
:'ai_field_naming_language',
|
|
318
329
|
:'redirect_url',
|
|
319
|
-
:'last_changed_at',
|
|
320
330
|
:'last_changed_by',
|
|
321
331
|
:'predefined_fields_sample_data',
|
|
322
332
|
:'html',
|
|
@@ -324,6 +334,7 @@ module DocSpring
|
|
|
324
334
|
:'header_html',
|
|
325
335
|
:'footer_html',
|
|
326
336
|
:'html_engine_options',
|
|
337
|
+
:'html_escape_data',
|
|
327
338
|
:'embed_edit_token',
|
|
328
339
|
])
|
|
329
340
|
end
|
|
@@ -378,6 +389,12 @@ module DocSpring
|
|
|
378
389
|
self.template_type = nil
|
|
379
390
|
end
|
|
380
391
|
|
|
392
|
+
if attributes.key?(:'output_format')
|
|
393
|
+
self.output_format = attributes[:'output_format']
|
|
394
|
+
else
|
|
395
|
+
self.output_format = nil
|
|
396
|
+
end
|
|
397
|
+
|
|
381
398
|
if attributes.key?(:'ready')
|
|
382
399
|
self.ready = attributes[:'ready']
|
|
383
400
|
else
|
|
@@ -402,12 +419,6 @@ module DocSpring
|
|
|
402
419
|
self.path = nil
|
|
403
420
|
end
|
|
404
421
|
|
|
405
|
-
if attributes.key?(:'version')
|
|
406
|
-
self.version = attributes[:'version']
|
|
407
|
-
else
|
|
408
|
-
self.version = nil
|
|
409
|
-
end
|
|
410
|
-
|
|
411
422
|
if attributes.key?(:'latest_version')
|
|
412
423
|
self.latest_version = attributes[:'latest_version']
|
|
413
424
|
else
|
|
@@ -426,6 +437,30 @@ module DocSpring
|
|
|
426
437
|
self.locked = nil
|
|
427
438
|
end
|
|
428
439
|
|
|
440
|
+
if attributes.key?(:'last_changed_at')
|
|
441
|
+
self.last_changed_at = attributes[:'last_changed_at']
|
|
442
|
+
else
|
|
443
|
+
self.last_changed_at = nil
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
if attributes.key?(:'created_at')
|
|
447
|
+
self.created_at = attributes[:'created_at']
|
|
448
|
+
else
|
|
449
|
+
self.created_at = nil
|
|
450
|
+
end
|
|
451
|
+
|
|
452
|
+
if attributes.key?(:'updated_at')
|
|
453
|
+
self.updated_at = attributes[:'updated_at']
|
|
454
|
+
else
|
|
455
|
+
self.updated_at = nil
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
if attributes.key?(:'version')
|
|
459
|
+
self.version = attributes[:'version']
|
|
460
|
+
else
|
|
461
|
+
self.version = nil
|
|
462
|
+
end
|
|
463
|
+
|
|
429
464
|
if attributes.key?(:'add_signature_request_submission_id_footers')
|
|
430
465
|
self.add_signature_request_submission_id_footers = attributes[:'add_signature_request_submission_id_footers']
|
|
431
466
|
else
|
|
@@ -554,30 +589,12 @@ module DocSpring
|
|
|
554
589
|
self.has_slack_webhook_url = nil
|
|
555
590
|
end
|
|
556
591
|
|
|
557
|
-
if attributes.key?(:'last_changed_at')
|
|
558
|
-
self.last_changed_at = attributes[:'last_changed_at']
|
|
559
|
-
else
|
|
560
|
-
self.last_changed_at = nil
|
|
561
|
-
end
|
|
562
|
-
|
|
563
592
|
if attributes.key?(:'last_changed_by')
|
|
564
593
|
self.last_changed_by = attributes[:'last_changed_by']
|
|
565
594
|
else
|
|
566
595
|
self.last_changed_by = nil
|
|
567
596
|
end
|
|
568
597
|
|
|
569
|
-
if attributes.key?(:'created_at')
|
|
570
|
-
self.created_at = attributes[:'created_at']
|
|
571
|
-
else
|
|
572
|
-
self.created_at = nil
|
|
573
|
-
end
|
|
574
|
-
|
|
575
|
-
if attributes.key?(:'updated_at')
|
|
576
|
-
self.updated_at = attributes[:'updated_at']
|
|
577
|
-
else
|
|
578
|
-
self.updated_at = nil
|
|
579
|
-
end
|
|
580
|
-
|
|
581
598
|
if attributes.key?(:'defaults')
|
|
582
599
|
self.defaults = attributes[:'defaults']
|
|
583
600
|
else
|
|
@@ -646,6 +663,12 @@ module DocSpring
|
|
|
646
663
|
self.html_engine_options = nil
|
|
647
664
|
end
|
|
648
665
|
|
|
666
|
+
if attributes.key?(:'html_escape_data')
|
|
667
|
+
self.html_escape_data = attributes[:'html_escape_data']
|
|
668
|
+
else
|
|
669
|
+
self.html_escape_data = nil
|
|
670
|
+
end
|
|
671
|
+
|
|
649
672
|
if attributes.key?(:'embed_edit_token')
|
|
650
673
|
self.embed_edit_token = attributes[:'embed_edit_token']
|
|
651
674
|
else
|
|
@@ -674,6 +697,10 @@ module DocSpring
|
|
|
674
697
|
invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
|
|
675
698
|
end
|
|
676
699
|
|
|
700
|
+
if @output_format.nil?
|
|
701
|
+
invalid_properties.push('invalid value for "output_format", output_format cannot be nil.')
|
|
702
|
+
end
|
|
703
|
+
|
|
677
704
|
if @ready.nil?
|
|
678
705
|
invalid_properties.push('invalid value for "ready", ready cannot be nil.')
|
|
679
706
|
end
|
|
@@ -686,6 +713,14 @@ module DocSpring
|
|
|
686
713
|
invalid_properties.push('invalid value for "locked", locked cannot be nil.')
|
|
687
714
|
end
|
|
688
715
|
|
|
716
|
+
if @created_at.nil?
|
|
717
|
+
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
|
718
|
+
end
|
|
719
|
+
|
|
720
|
+
if @updated_at.nil?
|
|
721
|
+
invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
|
|
722
|
+
end
|
|
723
|
+
|
|
689
724
|
if @add_signature_request_submission_id_footers.nil?
|
|
690
725
|
invalid_properties.push('invalid value for "add_signature_request_submission_id_footers", add_signature_request_submission_id_footers cannot be nil.')
|
|
691
726
|
end
|
|
@@ -762,14 +797,6 @@ module DocSpring
|
|
|
762
797
|
invalid_properties.push('invalid value for "has_slack_webhook_url", has_slack_webhook_url cannot be nil.')
|
|
763
798
|
end
|
|
764
799
|
|
|
765
|
-
if @created_at.nil?
|
|
766
|
-
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
|
767
|
-
end
|
|
768
|
-
|
|
769
|
-
if @updated_at.nil?
|
|
770
|
-
invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
|
|
771
|
-
end
|
|
772
|
-
|
|
773
800
|
if @defaults.nil?
|
|
774
801
|
invalid_properties.push('invalid value for "defaults", defaults cannot be nil.')
|
|
775
802
|
end
|
|
@@ -799,9 +826,12 @@ module DocSpring
|
|
|
799
826
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
800
827
|
return false if @id.nil?
|
|
801
828
|
return false if @template_type.nil?
|
|
829
|
+
return false if @output_format.nil?
|
|
802
830
|
return false if @ready.nil?
|
|
803
831
|
return false if @path.nil?
|
|
804
832
|
return false if @locked.nil?
|
|
833
|
+
return false if @created_at.nil?
|
|
834
|
+
return false if @updated_at.nil?
|
|
805
835
|
return false if @add_signature_request_submission_id_footers.nil?
|
|
806
836
|
return false if @allow_additional_properties.nil?
|
|
807
837
|
return false if @allow_skipping_optional_fields.nil?
|
|
@@ -821,8 +851,6 @@ module DocSpring
|
|
|
821
851
|
return false if @public_submissions.nil?
|
|
822
852
|
return false if @public_web_form.nil?
|
|
823
853
|
return false if @has_slack_webhook_url.nil?
|
|
824
|
-
return false if @created_at.nil?
|
|
825
|
-
return false if @updated_at.nil?
|
|
826
854
|
return false if @defaults.nil?
|
|
827
855
|
return false if @field_dependencies.nil?
|
|
828
856
|
return false if @field_groups.nil?
|
|
@@ -851,6 +879,16 @@ module DocSpring
|
|
|
851
879
|
@template_type = template_type
|
|
852
880
|
end
|
|
853
881
|
|
|
882
|
+
# Custom attribute writer method with validation
|
|
883
|
+
# @param [Object] output_format Value to be assigned
|
|
884
|
+
def output_format=(output_format)
|
|
885
|
+
if output_format.nil?
|
|
886
|
+
fail ArgumentError, 'output_format cannot be nil'
|
|
887
|
+
end
|
|
888
|
+
|
|
889
|
+
@output_format = output_format
|
|
890
|
+
end
|
|
891
|
+
|
|
854
892
|
# Custom attribute writer method with validation
|
|
855
893
|
# @param [Object] ready Value to be assigned
|
|
856
894
|
def ready=(ready)
|
|
@@ -881,6 +919,26 @@ module DocSpring
|
|
|
881
919
|
@locked = locked
|
|
882
920
|
end
|
|
883
921
|
|
|
922
|
+
# Custom attribute writer method with validation
|
|
923
|
+
# @param [Object] created_at Value to be assigned
|
|
924
|
+
def created_at=(created_at)
|
|
925
|
+
if created_at.nil?
|
|
926
|
+
fail ArgumentError, 'created_at cannot be nil'
|
|
927
|
+
end
|
|
928
|
+
|
|
929
|
+
@created_at = created_at
|
|
930
|
+
end
|
|
931
|
+
|
|
932
|
+
# Custom attribute writer method with validation
|
|
933
|
+
# @param [Object] updated_at Value to be assigned
|
|
934
|
+
def updated_at=(updated_at)
|
|
935
|
+
if updated_at.nil?
|
|
936
|
+
fail ArgumentError, 'updated_at cannot be nil'
|
|
937
|
+
end
|
|
938
|
+
|
|
939
|
+
@updated_at = updated_at
|
|
940
|
+
end
|
|
941
|
+
|
|
884
942
|
# Custom attribute writer method with validation
|
|
885
943
|
# @param [Object] add_signature_request_submission_id_footers Value to be assigned
|
|
886
944
|
def add_signature_request_submission_id_footers=(add_signature_request_submission_id_footers)
|
|
@@ -1071,26 +1129,6 @@ module DocSpring
|
|
|
1071
1129
|
@has_slack_webhook_url = has_slack_webhook_url
|
|
1072
1130
|
end
|
|
1073
1131
|
|
|
1074
|
-
# Custom attribute writer method with validation
|
|
1075
|
-
# @param [Object] created_at Value to be assigned
|
|
1076
|
-
def created_at=(created_at)
|
|
1077
|
-
if created_at.nil?
|
|
1078
|
-
fail ArgumentError, 'created_at cannot be nil'
|
|
1079
|
-
end
|
|
1080
|
-
|
|
1081
|
-
@created_at = created_at
|
|
1082
|
-
end
|
|
1083
|
-
|
|
1084
|
-
# Custom attribute writer method with validation
|
|
1085
|
-
# @param [Object] updated_at Value to be assigned
|
|
1086
|
-
def updated_at=(updated_at)
|
|
1087
|
-
if updated_at.nil?
|
|
1088
|
-
fail ArgumentError, 'updated_at cannot be nil'
|
|
1089
|
-
end
|
|
1090
|
-
|
|
1091
|
-
@updated_at = updated_at
|
|
1092
|
-
end
|
|
1093
|
-
|
|
1094
1132
|
# Custom attribute writer method with validation
|
|
1095
1133
|
# @param [Object] defaults Value to be assigned
|
|
1096
1134
|
def defaults=(defaults)
|
|
@@ -1150,14 +1188,18 @@ module DocSpring
|
|
|
1150
1188
|
name == o.name &&
|
|
1151
1189
|
description == o.description &&
|
|
1152
1190
|
template_type == o.template_type &&
|
|
1191
|
+
output_format == o.output_format &&
|
|
1153
1192
|
ready == o.ready &&
|
|
1154
1193
|
document == o.document &&
|
|
1155
1194
|
parent_folder_id == o.parent_folder_id &&
|
|
1156
1195
|
path == o.path &&
|
|
1157
|
-
version == o.version &&
|
|
1158
1196
|
latest_version == o.latest_version &&
|
|
1159
1197
|
version_published_at == o.version_published_at &&
|
|
1160
1198
|
locked == o.locked &&
|
|
1199
|
+
last_changed_at == o.last_changed_at &&
|
|
1200
|
+
created_at == o.created_at &&
|
|
1201
|
+
updated_at == o.updated_at &&
|
|
1202
|
+
version == o.version &&
|
|
1161
1203
|
add_signature_request_submission_id_footers == o.add_signature_request_submission_id_footers &&
|
|
1162
1204
|
ai_field_naming_language == o.ai_field_naming_language &&
|
|
1163
1205
|
allow_additional_properties == o.allow_additional_properties &&
|
|
@@ -1179,10 +1221,7 @@ module DocSpring
|
|
|
1179
1221
|
public_web_form == o.public_web_form &&
|
|
1180
1222
|
redirect_url == o.redirect_url &&
|
|
1181
1223
|
has_slack_webhook_url == o.has_slack_webhook_url &&
|
|
1182
|
-
last_changed_at == o.last_changed_at &&
|
|
1183
1224
|
last_changed_by == o.last_changed_by &&
|
|
1184
|
-
created_at == o.created_at &&
|
|
1185
|
-
updated_at == o.updated_at &&
|
|
1186
1225
|
defaults == o.defaults &&
|
|
1187
1226
|
field_dependencies == o.field_dependencies &&
|
|
1188
1227
|
field_groups == o.field_groups &&
|
|
@@ -1193,6 +1232,7 @@ module DocSpring
|
|
|
1193
1232
|
header_html == o.header_html &&
|
|
1194
1233
|
footer_html == o.footer_html &&
|
|
1195
1234
|
html_engine_options == o.html_engine_options &&
|
|
1235
|
+
html_escape_data == o.html_escape_data &&
|
|
1196
1236
|
embed_edit_token == o.embed_edit_token &&
|
|
1197
1237
|
versions == o.versions
|
|
1198
1238
|
end
|
|
@@ -1206,7 +1246,7 @@ module DocSpring
|
|
|
1206
1246
|
# Calculates hash code according to all attributes.
|
|
1207
1247
|
# @return [Integer] Hash code
|
|
1208
1248
|
def hash
|
|
1209
|
-
[id, name, description, template_type, ready, document, parent_folder_id, path,
|
|
1249
|
+
[id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, 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, has_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, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions].hash
|
|
1210
1250
|
end
|
|
1211
1251
|
|
|
1212
1252
|
# Builds the object from hash
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
@@ -16,7 +16,7 @@ require 'time'
|
|
|
16
16
|
module DocSpring
|
|
17
17
|
# A user in your account, an API token, or someone using the embedded template editor.
|
|
18
18
|
class TemplateActor < ApiModelBase
|
|
19
|
-
# `user`: a user in your account. `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app.
|
|
19
|
+
# `user`: a user in your account, also when they make the change with an app they connected (an OAuth access token). `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app.
|
|
20
20
|
attr_accessor :type
|
|
21
21
|
|
|
22
22
|
# The user's ID, for `user`.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
@@ -31,10 +31,10 @@ module DocSpring
|
|
|
31
31
|
# The fields that changed.
|
|
32
32
|
attr_accessor :fields
|
|
33
33
|
|
|
34
|
-
# The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `
|
|
34
|
+
# The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `merge_audit_trail_pdf`, ...). Values aren't included. Settings that apply to every version, such as `webhook_url` and `encrypt_pdfs_password`, are the same on every version, so they're named only when there's no earlier version to compare with; a secret is named without its value.
|
|
35
35
|
attr_accessor :changed_settings
|
|
36
36
|
|
|
37
|
-
# The template's PDF was replaced (or added, when there's no `from_version`).
|
|
37
|
+
# The template's PDF was replaced, or its Word document replaced or edited (or added, when there's no `from_version`).
|
|
38
38
|
attr_accessor :document_changed
|
|
39
39
|
|
|
40
40
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: v2
|
|
7
7
|
|