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
|
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module DocSpring
|
|
17
|
-
# A template in a list. Get a template by its ID for its HTML, defaults, field dependency rules and published versions.
|
|
17
|
+
# A template in a list: its name, type, folder, latest published version and whether it's ready. Get a template by its ID for its settings, its PDF in full, its HTML, defaults, field dependency rules and published versions.
|
|
18
18
|
class TemplateSummary < ApiModelBase
|
|
19
19
|
# The template's ID.
|
|
20
20
|
attr_accessor :id
|
|
@@ -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: its file name, page count and processing state. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url`, or a Word template created from an OpenDocument file (.odt), has one, with no file, while it's downloaded or converted.
|
|
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,75 +52,9 @@ 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
|
-
# Print the submission ID in the footer of each page of PDFs signed through signature requests.
|
|
56
|
-
attr_accessor :add_signature_request_submission_id_footers
|
|
57
|
-
|
|
58
|
-
# The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates.
|
|
59
|
-
attr_accessor :ai_field_naming_language
|
|
60
|
-
|
|
61
|
-
# Accept submission data with properties that aren't fields of the template.
|
|
62
|
-
attr_accessor :allow_additional_properties
|
|
63
|
-
|
|
64
|
-
# 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
|
-
attr_accessor :allow_skipping_optional_fields
|
|
66
|
-
|
|
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). HTML templates have no visual form, so `web` is the only value they accept.
|
|
68
|
-
attr_accessor :default_form_mode
|
|
69
|
-
|
|
70
|
-
# Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
|
|
71
|
-
attr_accessor :editable_submissions
|
|
72
|
-
|
|
73
|
-
# The sites where the template's signature requests, forms and embedded template editor can be loaded: 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). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
|
|
74
|
-
attr_accessor :embed_domains
|
|
75
|
-
|
|
76
|
-
# Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
|
|
77
|
-
attr_accessor :embed_edit_allow_settings
|
|
78
|
-
|
|
79
|
-
# Allow the embedded template editor to publish, restore, compare and delete published versions.
|
|
80
|
-
attr_accessor :embed_edit_allow_versioning
|
|
81
|
-
|
|
82
|
-
# Allow the embedded template editor to replace the template's PDF.
|
|
83
|
-
attr_accessor :embed_edit_allow_document_replacement
|
|
84
|
-
|
|
85
|
-
# Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
86
|
-
attr_accessor :encrypt_pdfs
|
|
87
|
-
|
|
88
|
-
# Whether `encrypt_pdfs_password` is set.
|
|
89
|
-
attr_accessor :has_encrypt_pdfs_password
|
|
90
|
-
|
|
91
|
-
# Delete each submission's data and PDF after `expire_after` `expiration_interval`.
|
|
92
|
-
attr_accessor :expire_submissions
|
|
93
|
-
|
|
94
|
-
# How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` is on. At most 5256000 (10 years in minutes).
|
|
95
|
-
attr_accessor :expire_after
|
|
96
|
-
|
|
97
|
-
# The unit of `expire_after`.
|
|
98
|
-
attr_accessor :expiration_interval
|
|
99
|
-
|
|
100
|
-
# Add the audit trail to the end of PDFs signed through signature requests.
|
|
101
|
-
attr_accessor :merge_audit_trail_pdf
|
|
102
|
-
|
|
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.
|
|
104
|
-
attr_accessor :parse_dates_using_template_date_format
|
|
105
|
-
|
|
106
|
-
# Allow anyone with a submission's ID to download its PDF.
|
|
107
|
-
attr_accessor :public_submissions
|
|
108
|
-
|
|
109
|
-
# Allow anyone to fill in the template's web form.
|
|
110
|
-
attr_accessor :public_web_form
|
|
111
|
-
|
|
112
|
-
# Where the web form sends people after they submit it.
|
|
113
|
-
attr_accessor :redirect_url
|
|
114
|
-
|
|
115
|
-
# Whether `slack_webhook_url` is set.
|
|
116
|
-
attr_accessor :has_slack_webhook_url
|
|
117
|
-
|
|
118
55
|
# When the draft was last changed.
|
|
119
56
|
attr_accessor :last_changed_at
|
|
120
57
|
|
|
121
|
-
# 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
|
-
attr_accessor :last_changed_by
|
|
123
|
-
|
|
124
58
|
# When the template was created.
|
|
125
59
|
attr_accessor :created_at
|
|
126
60
|
|
|
@@ -156,37 +90,15 @@ module DocSpring
|
|
|
156
90
|
:'name' => :'name',
|
|
157
91
|
:'description' => :'description',
|
|
158
92
|
:'template_type' => :'template_type',
|
|
93
|
+
:'output_format' => :'output_format',
|
|
159
94
|
:'ready' => :'ready',
|
|
160
95
|
:'document' => :'document',
|
|
161
96
|
:'parent_folder_id' => :'parent_folder_id',
|
|
162
97
|
:'path' => :'path',
|
|
163
|
-
:'version' => :'version',
|
|
164
98
|
:'latest_version' => :'latest_version',
|
|
165
99
|
:'version_published_at' => :'version_published_at',
|
|
166
100
|
:'locked' => :'locked',
|
|
167
|
-
:'add_signature_request_submission_id_footers' => :'add_signature_request_submission_id_footers',
|
|
168
|
-
:'ai_field_naming_language' => :'ai_field_naming_language',
|
|
169
|
-
:'allow_additional_properties' => :'allow_additional_properties',
|
|
170
|
-
:'allow_skipping_optional_fields' => :'allow_skipping_optional_fields',
|
|
171
|
-
:'default_form_mode' => :'default_form_mode',
|
|
172
|
-
:'editable_submissions' => :'editable_submissions',
|
|
173
|
-
:'embed_domains' => :'embed_domains',
|
|
174
|
-
:'embed_edit_allow_settings' => :'embed_edit_allow_settings',
|
|
175
|
-
:'embed_edit_allow_versioning' => :'embed_edit_allow_versioning',
|
|
176
|
-
:'embed_edit_allow_document_replacement' => :'embed_edit_allow_document_replacement',
|
|
177
|
-
:'encrypt_pdfs' => :'encrypt_pdfs',
|
|
178
|
-
:'has_encrypt_pdfs_password' => :'has_encrypt_pdfs_password',
|
|
179
|
-
:'expire_submissions' => :'expire_submissions',
|
|
180
|
-
:'expire_after' => :'expire_after',
|
|
181
|
-
:'expiration_interval' => :'expiration_interval',
|
|
182
|
-
:'merge_audit_trail_pdf' => :'merge_audit_trail_pdf',
|
|
183
|
-
:'parse_dates_using_template_date_format' => :'parse_dates_using_template_date_format',
|
|
184
|
-
:'public_submissions' => :'public_submissions',
|
|
185
|
-
:'public_web_form' => :'public_web_form',
|
|
186
|
-
:'redirect_url' => :'redirect_url',
|
|
187
|
-
:'has_slack_webhook_url' => :'has_slack_webhook_url',
|
|
188
101
|
:'last_changed_at' => :'last_changed_at',
|
|
189
|
-
:'last_changed_by' => :'last_changed_by',
|
|
190
102
|
:'created_at' => :'created_at',
|
|
191
103
|
:'updated_at' => :'updated_at'
|
|
192
104
|
}
|
|
@@ -209,37 +121,15 @@ module DocSpring
|
|
|
209
121
|
:'name' => :'String',
|
|
210
122
|
:'description' => :'String',
|
|
211
123
|
:'template_type' => :'TemplateType',
|
|
124
|
+
:'output_format' => :'OutputFormat',
|
|
212
125
|
:'ready' => :'Boolean',
|
|
213
|
-
:'document' => :'
|
|
126
|
+
:'document' => :'TemplateDocumentSummary',
|
|
214
127
|
:'parent_folder_id' => :'String',
|
|
215
128
|
:'path' => :'String',
|
|
216
|
-
:'version' => :'String',
|
|
217
129
|
:'latest_version' => :'String',
|
|
218
130
|
:'version_published_at' => :'Time',
|
|
219
131
|
:'locked' => :'Boolean',
|
|
220
|
-
:'add_signature_request_submission_id_footers' => :'Boolean',
|
|
221
|
-
:'ai_field_naming_language' => :'AiFieldNamingLanguage',
|
|
222
|
-
:'allow_additional_properties' => :'Boolean',
|
|
223
|
-
:'allow_skipping_optional_fields' => :'Boolean',
|
|
224
|
-
:'default_form_mode' => :'TemplateFormMode',
|
|
225
|
-
:'editable_submissions' => :'Boolean',
|
|
226
|
-
:'embed_domains' => :'Array<String>',
|
|
227
|
-
:'embed_edit_allow_settings' => :'Boolean',
|
|
228
|
-
:'embed_edit_allow_versioning' => :'Boolean',
|
|
229
|
-
:'embed_edit_allow_document_replacement' => :'Boolean',
|
|
230
|
-
:'encrypt_pdfs' => :'Boolean',
|
|
231
|
-
:'has_encrypt_pdfs_password' => :'Boolean',
|
|
232
|
-
:'expire_submissions' => :'Boolean',
|
|
233
|
-
:'expire_after' => :'Integer',
|
|
234
|
-
:'expiration_interval' => :'ExpirationInterval',
|
|
235
|
-
:'merge_audit_trail_pdf' => :'Boolean',
|
|
236
|
-
:'parse_dates_using_template_date_format' => :'Boolean',
|
|
237
|
-
:'public_submissions' => :'Boolean',
|
|
238
|
-
:'public_web_form' => :'Boolean',
|
|
239
|
-
:'redirect_url' => :'String',
|
|
240
|
-
:'has_slack_webhook_url' => :'Boolean',
|
|
241
132
|
:'last_changed_at' => :'Time',
|
|
242
|
-
:'last_changed_by' => :'TemplateActor',
|
|
243
133
|
:'created_at' => :'Time',
|
|
244
134
|
:'updated_at' => :'Time'
|
|
245
135
|
}
|
|
@@ -252,13 +142,9 @@ module DocSpring
|
|
|
252
142
|
:'description',
|
|
253
143
|
:'document',
|
|
254
144
|
:'parent_folder_id',
|
|
255
|
-
:'version',
|
|
256
145
|
:'latest_version',
|
|
257
146
|
:'version_published_at',
|
|
258
|
-
:'ai_field_naming_language',
|
|
259
|
-
:'redirect_url',
|
|
260
147
|
:'last_changed_at',
|
|
261
|
-
:'last_changed_by',
|
|
262
148
|
])
|
|
263
149
|
end
|
|
264
150
|
|
|
@@ -312,6 +198,12 @@ module DocSpring
|
|
|
312
198
|
self.template_type = nil
|
|
313
199
|
end
|
|
314
200
|
|
|
201
|
+
if attributes.key?(:'output_format')
|
|
202
|
+
self.output_format = attributes[:'output_format']
|
|
203
|
+
else
|
|
204
|
+
self.output_format = nil
|
|
205
|
+
end
|
|
206
|
+
|
|
315
207
|
if attributes.key?(:'ready')
|
|
316
208
|
self.ready = attributes[:'ready']
|
|
317
209
|
else
|
|
@@ -336,12 +228,6 @@ module DocSpring
|
|
|
336
228
|
self.path = nil
|
|
337
229
|
end
|
|
338
230
|
|
|
339
|
-
if attributes.key?(:'version')
|
|
340
|
-
self.version = attributes[:'version']
|
|
341
|
-
else
|
|
342
|
-
self.version = nil
|
|
343
|
-
end
|
|
344
|
-
|
|
345
231
|
if attributes.key?(:'latest_version')
|
|
346
232
|
self.latest_version = attributes[:'latest_version']
|
|
347
233
|
else
|
|
@@ -360,146 +246,12 @@ module DocSpring
|
|
|
360
246
|
self.locked = nil
|
|
361
247
|
end
|
|
362
248
|
|
|
363
|
-
if attributes.key?(:'add_signature_request_submission_id_footers')
|
|
364
|
-
self.add_signature_request_submission_id_footers = attributes[:'add_signature_request_submission_id_footers']
|
|
365
|
-
else
|
|
366
|
-
self.add_signature_request_submission_id_footers = nil
|
|
367
|
-
end
|
|
368
|
-
|
|
369
|
-
if attributes.key?(:'ai_field_naming_language')
|
|
370
|
-
self.ai_field_naming_language = attributes[:'ai_field_naming_language']
|
|
371
|
-
else
|
|
372
|
-
self.ai_field_naming_language = nil
|
|
373
|
-
end
|
|
374
|
-
|
|
375
|
-
if attributes.key?(:'allow_additional_properties')
|
|
376
|
-
self.allow_additional_properties = attributes[:'allow_additional_properties']
|
|
377
|
-
else
|
|
378
|
-
self.allow_additional_properties = nil
|
|
379
|
-
end
|
|
380
|
-
|
|
381
|
-
if attributes.key?(:'allow_skipping_optional_fields')
|
|
382
|
-
self.allow_skipping_optional_fields = attributes[:'allow_skipping_optional_fields']
|
|
383
|
-
else
|
|
384
|
-
self.allow_skipping_optional_fields = nil
|
|
385
|
-
end
|
|
386
|
-
|
|
387
|
-
if attributes.key?(:'default_form_mode')
|
|
388
|
-
self.default_form_mode = attributes[:'default_form_mode']
|
|
389
|
-
else
|
|
390
|
-
self.default_form_mode = nil
|
|
391
|
-
end
|
|
392
|
-
|
|
393
|
-
if attributes.key?(:'editable_submissions')
|
|
394
|
-
self.editable_submissions = attributes[:'editable_submissions']
|
|
395
|
-
else
|
|
396
|
-
self.editable_submissions = nil
|
|
397
|
-
end
|
|
398
|
-
|
|
399
|
-
if attributes.key?(:'embed_domains')
|
|
400
|
-
if (value = attributes[:'embed_domains']).is_a?(Array)
|
|
401
|
-
self.embed_domains = value
|
|
402
|
-
end
|
|
403
|
-
else
|
|
404
|
-
self.embed_domains = nil
|
|
405
|
-
end
|
|
406
|
-
|
|
407
|
-
if attributes.key?(:'embed_edit_allow_settings')
|
|
408
|
-
self.embed_edit_allow_settings = attributes[:'embed_edit_allow_settings']
|
|
409
|
-
else
|
|
410
|
-
self.embed_edit_allow_settings = nil
|
|
411
|
-
end
|
|
412
|
-
|
|
413
|
-
if attributes.key?(:'embed_edit_allow_versioning')
|
|
414
|
-
self.embed_edit_allow_versioning = attributes[:'embed_edit_allow_versioning']
|
|
415
|
-
else
|
|
416
|
-
self.embed_edit_allow_versioning = nil
|
|
417
|
-
end
|
|
418
|
-
|
|
419
|
-
if attributes.key?(:'embed_edit_allow_document_replacement')
|
|
420
|
-
self.embed_edit_allow_document_replacement = attributes[:'embed_edit_allow_document_replacement']
|
|
421
|
-
else
|
|
422
|
-
self.embed_edit_allow_document_replacement = nil
|
|
423
|
-
end
|
|
424
|
-
|
|
425
|
-
if attributes.key?(:'encrypt_pdfs')
|
|
426
|
-
self.encrypt_pdfs = attributes[:'encrypt_pdfs']
|
|
427
|
-
else
|
|
428
|
-
self.encrypt_pdfs = nil
|
|
429
|
-
end
|
|
430
|
-
|
|
431
|
-
if attributes.key?(:'has_encrypt_pdfs_password')
|
|
432
|
-
self.has_encrypt_pdfs_password = attributes[:'has_encrypt_pdfs_password']
|
|
433
|
-
else
|
|
434
|
-
self.has_encrypt_pdfs_password = nil
|
|
435
|
-
end
|
|
436
|
-
|
|
437
|
-
if attributes.key?(:'expire_submissions')
|
|
438
|
-
self.expire_submissions = attributes[:'expire_submissions']
|
|
439
|
-
else
|
|
440
|
-
self.expire_submissions = nil
|
|
441
|
-
end
|
|
442
|
-
|
|
443
|
-
if attributes.key?(:'expire_after')
|
|
444
|
-
self.expire_after = attributes[:'expire_after']
|
|
445
|
-
else
|
|
446
|
-
self.expire_after = nil
|
|
447
|
-
end
|
|
448
|
-
|
|
449
|
-
if attributes.key?(:'expiration_interval')
|
|
450
|
-
self.expiration_interval = attributes[:'expiration_interval']
|
|
451
|
-
else
|
|
452
|
-
self.expiration_interval = nil
|
|
453
|
-
end
|
|
454
|
-
|
|
455
|
-
if attributes.key?(:'merge_audit_trail_pdf')
|
|
456
|
-
self.merge_audit_trail_pdf = attributes[:'merge_audit_trail_pdf']
|
|
457
|
-
else
|
|
458
|
-
self.merge_audit_trail_pdf = nil
|
|
459
|
-
end
|
|
460
|
-
|
|
461
|
-
if attributes.key?(:'parse_dates_using_template_date_format')
|
|
462
|
-
self.parse_dates_using_template_date_format = attributes[:'parse_dates_using_template_date_format']
|
|
463
|
-
else
|
|
464
|
-
self.parse_dates_using_template_date_format = nil
|
|
465
|
-
end
|
|
466
|
-
|
|
467
|
-
if attributes.key?(:'public_submissions')
|
|
468
|
-
self.public_submissions = attributes[:'public_submissions']
|
|
469
|
-
else
|
|
470
|
-
self.public_submissions = nil
|
|
471
|
-
end
|
|
472
|
-
|
|
473
|
-
if attributes.key?(:'public_web_form')
|
|
474
|
-
self.public_web_form = attributes[:'public_web_form']
|
|
475
|
-
else
|
|
476
|
-
self.public_web_form = nil
|
|
477
|
-
end
|
|
478
|
-
|
|
479
|
-
if attributes.key?(:'redirect_url')
|
|
480
|
-
self.redirect_url = attributes[:'redirect_url']
|
|
481
|
-
else
|
|
482
|
-
self.redirect_url = nil
|
|
483
|
-
end
|
|
484
|
-
|
|
485
|
-
if attributes.key?(:'has_slack_webhook_url')
|
|
486
|
-
self.has_slack_webhook_url = attributes[:'has_slack_webhook_url']
|
|
487
|
-
else
|
|
488
|
-
self.has_slack_webhook_url = nil
|
|
489
|
-
end
|
|
490
|
-
|
|
491
249
|
if attributes.key?(:'last_changed_at')
|
|
492
250
|
self.last_changed_at = attributes[:'last_changed_at']
|
|
493
251
|
else
|
|
494
252
|
self.last_changed_at = nil
|
|
495
253
|
end
|
|
496
254
|
|
|
497
|
-
if attributes.key?(:'last_changed_by')
|
|
498
|
-
self.last_changed_by = attributes[:'last_changed_by']
|
|
499
|
-
else
|
|
500
|
-
self.last_changed_by = nil
|
|
501
|
-
end
|
|
502
|
-
|
|
503
255
|
if attributes.key?(:'created_at')
|
|
504
256
|
self.created_at = attributes[:'created_at']
|
|
505
257
|
else
|
|
@@ -526,6 +278,10 @@ module DocSpring
|
|
|
526
278
|
invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
|
|
527
279
|
end
|
|
528
280
|
|
|
281
|
+
if @output_format.nil?
|
|
282
|
+
invalid_properties.push('invalid value for "output_format", output_format cannot be nil.')
|
|
283
|
+
end
|
|
284
|
+
|
|
529
285
|
if @ready.nil?
|
|
530
286
|
invalid_properties.push('invalid value for "ready", ready cannot be nil.')
|
|
531
287
|
end
|
|
@@ -538,82 +294,6 @@ module DocSpring
|
|
|
538
294
|
invalid_properties.push('invalid value for "locked", locked cannot be nil.')
|
|
539
295
|
end
|
|
540
296
|
|
|
541
|
-
if @add_signature_request_submission_id_footers.nil?
|
|
542
|
-
invalid_properties.push('invalid value for "add_signature_request_submission_id_footers", add_signature_request_submission_id_footers cannot be nil.')
|
|
543
|
-
end
|
|
544
|
-
|
|
545
|
-
if @allow_additional_properties.nil?
|
|
546
|
-
invalid_properties.push('invalid value for "allow_additional_properties", allow_additional_properties cannot be nil.')
|
|
547
|
-
end
|
|
548
|
-
|
|
549
|
-
if @allow_skipping_optional_fields.nil?
|
|
550
|
-
invalid_properties.push('invalid value for "allow_skipping_optional_fields", allow_skipping_optional_fields cannot be nil.')
|
|
551
|
-
end
|
|
552
|
-
|
|
553
|
-
if @default_form_mode.nil?
|
|
554
|
-
invalid_properties.push('invalid value for "default_form_mode", default_form_mode cannot be nil.')
|
|
555
|
-
end
|
|
556
|
-
|
|
557
|
-
if @editable_submissions.nil?
|
|
558
|
-
invalid_properties.push('invalid value for "editable_submissions", editable_submissions cannot be nil.')
|
|
559
|
-
end
|
|
560
|
-
|
|
561
|
-
if @embed_domains.nil?
|
|
562
|
-
invalid_properties.push('invalid value for "embed_domains", embed_domains cannot be nil.')
|
|
563
|
-
end
|
|
564
|
-
|
|
565
|
-
if @embed_edit_allow_settings.nil?
|
|
566
|
-
invalid_properties.push('invalid value for "embed_edit_allow_settings", embed_edit_allow_settings cannot be nil.')
|
|
567
|
-
end
|
|
568
|
-
|
|
569
|
-
if @embed_edit_allow_versioning.nil?
|
|
570
|
-
invalid_properties.push('invalid value for "embed_edit_allow_versioning", embed_edit_allow_versioning cannot be nil.')
|
|
571
|
-
end
|
|
572
|
-
|
|
573
|
-
if @embed_edit_allow_document_replacement.nil?
|
|
574
|
-
invalid_properties.push('invalid value for "embed_edit_allow_document_replacement", embed_edit_allow_document_replacement cannot be nil.')
|
|
575
|
-
end
|
|
576
|
-
|
|
577
|
-
if @encrypt_pdfs.nil?
|
|
578
|
-
invalid_properties.push('invalid value for "encrypt_pdfs", encrypt_pdfs cannot be nil.')
|
|
579
|
-
end
|
|
580
|
-
|
|
581
|
-
if @has_encrypt_pdfs_password.nil?
|
|
582
|
-
invalid_properties.push('invalid value for "has_encrypt_pdfs_password", has_encrypt_pdfs_password cannot be nil.')
|
|
583
|
-
end
|
|
584
|
-
|
|
585
|
-
if @expire_submissions.nil?
|
|
586
|
-
invalid_properties.push('invalid value for "expire_submissions", expire_submissions cannot be nil.')
|
|
587
|
-
end
|
|
588
|
-
|
|
589
|
-
if @expire_after.nil?
|
|
590
|
-
invalid_properties.push('invalid value for "expire_after", expire_after cannot be nil.')
|
|
591
|
-
end
|
|
592
|
-
|
|
593
|
-
if @expiration_interval.nil?
|
|
594
|
-
invalid_properties.push('invalid value for "expiration_interval", expiration_interval cannot be nil.')
|
|
595
|
-
end
|
|
596
|
-
|
|
597
|
-
if @merge_audit_trail_pdf.nil?
|
|
598
|
-
invalid_properties.push('invalid value for "merge_audit_trail_pdf", merge_audit_trail_pdf cannot be nil.')
|
|
599
|
-
end
|
|
600
|
-
|
|
601
|
-
if @parse_dates_using_template_date_format.nil?
|
|
602
|
-
invalid_properties.push('invalid value for "parse_dates_using_template_date_format", parse_dates_using_template_date_format cannot be nil.')
|
|
603
|
-
end
|
|
604
|
-
|
|
605
|
-
if @public_submissions.nil?
|
|
606
|
-
invalid_properties.push('invalid value for "public_submissions", public_submissions cannot be nil.')
|
|
607
|
-
end
|
|
608
|
-
|
|
609
|
-
if @public_web_form.nil?
|
|
610
|
-
invalid_properties.push('invalid value for "public_web_form", public_web_form cannot be nil.')
|
|
611
|
-
end
|
|
612
|
-
|
|
613
|
-
if @has_slack_webhook_url.nil?
|
|
614
|
-
invalid_properties.push('invalid value for "has_slack_webhook_url", has_slack_webhook_url cannot be nil.')
|
|
615
|
-
end
|
|
616
|
-
|
|
617
297
|
if @created_at.nil?
|
|
618
298
|
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
|
619
299
|
end
|
|
@@ -631,28 +311,10 @@ module DocSpring
|
|
|
631
311
|
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
632
312
|
return false if @id.nil?
|
|
633
313
|
return false if @template_type.nil?
|
|
314
|
+
return false if @output_format.nil?
|
|
634
315
|
return false if @ready.nil?
|
|
635
316
|
return false if @path.nil?
|
|
636
317
|
return false if @locked.nil?
|
|
637
|
-
return false if @add_signature_request_submission_id_footers.nil?
|
|
638
|
-
return false if @allow_additional_properties.nil?
|
|
639
|
-
return false if @allow_skipping_optional_fields.nil?
|
|
640
|
-
return false if @default_form_mode.nil?
|
|
641
|
-
return false if @editable_submissions.nil?
|
|
642
|
-
return false if @embed_domains.nil?
|
|
643
|
-
return false if @embed_edit_allow_settings.nil?
|
|
644
|
-
return false if @embed_edit_allow_versioning.nil?
|
|
645
|
-
return false if @embed_edit_allow_document_replacement.nil?
|
|
646
|
-
return false if @encrypt_pdfs.nil?
|
|
647
|
-
return false if @has_encrypt_pdfs_password.nil?
|
|
648
|
-
return false if @expire_submissions.nil?
|
|
649
|
-
return false if @expire_after.nil?
|
|
650
|
-
return false if @expiration_interval.nil?
|
|
651
|
-
return false if @merge_audit_trail_pdf.nil?
|
|
652
|
-
return false if @parse_dates_using_template_date_format.nil?
|
|
653
|
-
return false if @public_submissions.nil?
|
|
654
|
-
return false if @public_web_form.nil?
|
|
655
|
-
return false if @has_slack_webhook_url.nil?
|
|
656
318
|
return false if @created_at.nil?
|
|
657
319
|
return false if @updated_at.nil?
|
|
658
320
|
true
|
|
@@ -678,6 +340,16 @@ module DocSpring
|
|
|
678
340
|
@template_type = template_type
|
|
679
341
|
end
|
|
680
342
|
|
|
343
|
+
# Custom attribute writer method with validation
|
|
344
|
+
# @param [Object] output_format Value to be assigned
|
|
345
|
+
def output_format=(output_format)
|
|
346
|
+
if output_format.nil?
|
|
347
|
+
fail ArgumentError, 'output_format cannot be nil'
|
|
348
|
+
end
|
|
349
|
+
|
|
350
|
+
@output_format = output_format
|
|
351
|
+
end
|
|
352
|
+
|
|
681
353
|
# Custom attribute writer method with validation
|
|
682
354
|
# @param [Object] ready Value to be assigned
|
|
683
355
|
def ready=(ready)
|
|
@@ -708,196 +380,6 @@ module DocSpring
|
|
|
708
380
|
@locked = locked
|
|
709
381
|
end
|
|
710
382
|
|
|
711
|
-
# Custom attribute writer method with validation
|
|
712
|
-
# @param [Object] add_signature_request_submission_id_footers Value to be assigned
|
|
713
|
-
def add_signature_request_submission_id_footers=(add_signature_request_submission_id_footers)
|
|
714
|
-
if add_signature_request_submission_id_footers.nil?
|
|
715
|
-
fail ArgumentError, 'add_signature_request_submission_id_footers cannot be nil'
|
|
716
|
-
end
|
|
717
|
-
|
|
718
|
-
@add_signature_request_submission_id_footers = add_signature_request_submission_id_footers
|
|
719
|
-
end
|
|
720
|
-
|
|
721
|
-
# Custom attribute writer method with validation
|
|
722
|
-
# @param [Object] allow_additional_properties Value to be assigned
|
|
723
|
-
def allow_additional_properties=(allow_additional_properties)
|
|
724
|
-
if allow_additional_properties.nil?
|
|
725
|
-
fail ArgumentError, 'allow_additional_properties cannot be nil'
|
|
726
|
-
end
|
|
727
|
-
|
|
728
|
-
@allow_additional_properties = allow_additional_properties
|
|
729
|
-
end
|
|
730
|
-
|
|
731
|
-
# Custom attribute writer method with validation
|
|
732
|
-
# @param [Object] allow_skipping_optional_fields Value to be assigned
|
|
733
|
-
def allow_skipping_optional_fields=(allow_skipping_optional_fields)
|
|
734
|
-
if allow_skipping_optional_fields.nil?
|
|
735
|
-
fail ArgumentError, 'allow_skipping_optional_fields cannot be nil'
|
|
736
|
-
end
|
|
737
|
-
|
|
738
|
-
@allow_skipping_optional_fields = allow_skipping_optional_fields
|
|
739
|
-
end
|
|
740
|
-
|
|
741
|
-
# Custom attribute writer method with validation
|
|
742
|
-
# @param [Object] default_form_mode Value to be assigned
|
|
743
|
-
def default_form_mode=(default_form_mode)
|
|
744
|
-
if default_form_mode.nil?
|
|
745
|
-
fail ArgumentError, 'default_form_mode cannot be nil'
|
|
746
|
-
end
|
|
747
|
-
|
|
748
|
-
@default_form_mode = default_form_mode
|
|
749
|
-
end
|
|
750
|
-
|
|
751
|
-
# Custom attribute writer method with validation
|
|
752
|
-
# @param [Object] editable_submissions Value to be assigned
|
|
753
|
-
def editable_submissions=(editable_submissions)
|
|
754
|
-
if editable_submissions.nil?
|
|
755
|
-
fail ArgumentError, 'editable_submissions cannot be nil'
|
|
756
|
-
end
|
|
757
|
-
|
|
758
|
-
@editable_submissions = editable_submissions
|
|
759
|
-
end
|
|
760
|
-
|
|
761
|
-
# Custom attribute writer method with validation
|
|
762
|
-
# @param [Object] embed_domains Value to be assigned
|
|
763
|
-
def embed_domains=(embed_domains)
|
|
764
|
-
if embed_domains.nil?
|
|
765
|
-
fail ArgumentError, 'embed_domains cannot be nil'
|
|
766
|
-
end
|
|
767
|
-
|
|
768
|
-
@embed_domains = embed_domains
|
|
769
|
-
end
|
|
770
|
-
|
|
771
|
-
# Custom attribute writer method with validation
|
|
772
|
-
# @param [Object] embed_edit_allow_settings Value to be assigned
|
|
773
|
-
def embed_edit_allow_settings=(embed_edit_allow_settings)
|
|
774
|
-
if embed_edit_allow_settings.nil?
|
|
775
|
-
fail ArgumentError, 'embed_edit_allow_settings cannot be nil'
|
|
776
|
-
end
|
|
777
|
-
|
|
778
|
-
@embed_edit_allow_settings = embed_edit_allow_settings
|
|
779
|
-
end
|
|
780
|
-
|
|
781
|
-
# Custom attribute writer method with validation
|
|
782
|
-
# @param [Object] embed_edit_allow_versioning Value to be assigned
|
|
783
|
-
def embed_edit_allow_versioning=(embed_edit_allow_versioning)
|
|
784
|
-
if embed_edit_allow_versioning.nil?
|
|
785
|
-
fail ArgumentError, 'embed_edit_allow_versioning cannot be nil'
|
|
786
|
-
end
|
|
787
|
-
|
|
788
|
-
@embed_edit_allow_versioning = embed_edit_allow_versioning
|
|
789
|
-
end
|
|
790
|
-
|
|
791
|
-
# Custom attribute writer method with validation
|
|
792
|
-
# @param [Object] embed_edit_allow_document_replacement Value to be assigned
|
|
793
|
-
def embed_edit_allow_document_replacement=(embed_edit_allow_document_replacement)
|
|
794
|
-
if embed_edit_allow_document_replacement.nil?
|
|
795
|
-
fail ArgumentError, 'embed_edit_allow_document_replacement cannot be nil'
|
|
796
|
-
end
|
|
797
|
-
|
|
798
|
-
@embed_edit_allow_document_replacement = embed_edit_allow_document_replacement
|
|
799
|
-
end
|
|
800
|
-
|
|
801
|
-
# Custom attribute writer method with validation
|
|
802
|
-
# @param [Object] encrypt_pdfs Value to be assigned
|
|
803
|
-
def encrypt_pdfs=(encrypt_pdfs)
|
|
804
|
-
if encrypt_pdfs.nil?
|
|
805
|
-
fail ArgumentError, 'encrypt_pdfs cannot be nil'
|
|
806
|
-
end
|
|
807
|
-
|
|
808
|
-
@encrypt_pdfs = encrypt_pdfs
|
|
809
|
-
end
|
|
810
|
-
|
|
811
|
-
# Custom attribute writer method with validation
|
|
812
|
-
# @param [Object] has_encrypt_pdfs_password Value to be assigned
|
|
813
|
-
def has_encrypt_pdfs_password=(has_encrypt_pdfs_password)
|
|
814
|
-
if has_encrypt_pdfs_password.nil?
|
|
815
|
-
fail ArgumentError, 'has_encrypt_pdfs_password cannot be nil'
|
|
816
|
-
end
|
|
817
|
-
|
|
818
|
-
@has_encrypt_pdfs_password = has_encrypt_pdfs_password
|
|
819
|
-
end
|
|
820
|
-
|
|
821
|
-
# Custom attribute writer method with validation
|
|
822
|
-
# @param [Object] expire_submissions Value to be assigned
|
|
823
|
-
def expire_submissions=(expire_submissions)
|
|
824
|
-
if expire_submissions.nil?
|
|
825
|
-
fail ArgumentError, 'expire_submissions cannot be nil'
|
|
826
|
-
end
|
|
827
|
-
|
|
828
|
-
@expire_submissions = expire_submissions
|
|
829
|
-
end
|
|
830
|
-
|
|
831
|
-
# Custom attribute writer method with validation
|
|
832
|
-
# @param [Object] expire_after Value to be assigned
|
|
833
|
-
def expire_after=(expire_after)
|
|
834
|
-
if expire_after.nil?
|
|
835
|
-
fail ArgumentError, 'expire_after cannot be nil'
|
|
836
|
-
end
|
|
837
|
-
|
|
838
|
-
@expire_after = expire_after
|
|
839
|
-
end
|
|
840
|
-
|
|
841
|
-
# Custom attribute writer method with validation
|
|
842
|
-
# @param [Object] expiration_interval Value to be assigned
|
|
843
|
-
def expiration_interval=(expiration_interval)
|
|
844
|
-
if expiration_interval.nil?
|
|
845
|
-
fail ArgumentError, 'expiration_interval cannot be nil'
|
|
846
|
-
end
|
|
847
|
-
|
|
848
|
-
@expiration_interval = expiration_interval
|
|
849
|
-
end
|
|
850
|
-
|
|
851
|
-
# Custom attribute writer method with validation
|
|
852
|
-
# @param [Object] merge_audit_trail_pdf Value to be assigned
|
|
853
|
-
def merge_audit_trail_pdf=(merge_audit_trail_pdf)
|
|
854
|
-
if merge_audit_trail_pdf.nil?
|
|
855
|
-
fail ArgumentError, 'merge_audit_trail_pdf cannot be nil'
|
|
856
|
-
end
|
|
857
|
-
|
|
858
|
-
@merge_audit_trail_pdf = merge_audit_trail_pdf
|
|
859
|
-
end
|
|
860
|
-
|
|
861
|
-
# Custom attribute writer method with validation
|
|
862
|
-
# @param [Object] parse_dates_using_template_date_format Value to be assigned
|
|
863
|
-
def parse_dates_using_template_date_format=(parse_dates_using_template_date_format)
|
|
864
|
-
if parse_dates_using_template_date_format.nil?
|
|
865
|
-
fail ArgumentError, 'parse_dates_using_template_date_format cannot be nil'
|
|
866
|
-
end
|
|
867
|
-
|
|
868
|
-
@parse_dates_using_template_date_format = parse_dates_using_template_date_format
|
|
869
|
-
end
|
|
870
|
-
|
|
871
|
-
# Custom attribute writer method with validation
|
|
872
|
-
# @param [Object] public_submissions Value to be assigned
|
|
873
|
-
def public_submissions=(public_submissions)
|
|
874
|
-
if public_submissions.nil?
|
|
875
|
-
fail ArgumentError, 'public_submissions cannot be nil'
|
|
876
|
-
end
|
|
877
|
-
|
|
878
|
-
@public_submissions = public_submissions
|
|
879
|
-
end
|
|
880
|
-
|
|
881
|
-
# Custom attribute writer method with validation
|
|
882
|
-
# @param [Object] public_web_form Value to be assigned
|
|
883
|
-
def public_web_form=(public_web_form)
|
|
884
|
-
if public_web_form.nil?
|
|
885
|
-
fail ArgumentError, 'public_web_form cannot be nil'
|
|
886
|
-
end
|
|
887
|
-
|
|
888
|
-
@public_web_form = public_web_form
|
|
889
|
-
end
|
|
890
|
-
|
|
891
|
-
# Custom attribute writer method with validation
|
|
892
|
-
# @param [Object] has_slack_webhook_url Value to be assigned
|
|
893
|
-
def has_slack_webhook_url=(has_slack_webhook_url)
|
|
894
|
-
if has_slack_webhook_url.nil?
|
|
895
|
-
fail ArgumentError, 'has_slack_webhook_url cannot be nil'
|
|
896
|
-
end
|
|
897
|
-
|
|
898
|
-
@has_slack_webhook_url = has_slack_webhook_url
|
|
899
|
-
end
|
|
900
|
-
|
|
901
383
|
# Custom attribute writer method with validation
|
|
902
384
|
# @param [Object] created_at Value to be assigned
|
|
903
385
|
def created_at=(created_at)
|
|
@@ -927,37 +409,15 @@ module DocSpring
|
|
|
927
409
|
name == o.name &&
|
|
928
410
|
description == o.description &&
|
|
929
411
|
template_type == o.template_type &&
|
|
412
|
+
output_format == o.output_format &&
|
|
930
413
|
ready == o.ready &&
|
|
931
414
|
document == o.document &&
|
|
932
415
|
parent_folder_id == o.parent_folder_id &&
|
|
933
416
|
path == o.path &&
|
|
934
|
-
version == o.version &&
|
|
935
417
|
latest_version == o.latest_version &&
|
|
936
418
|
version_published_at == o.version_published_at &&
|
|
937
419
|
locked == o.locked &&
|
|
938
|
-
add_signature_request_submission_id_footers == o.add_signature_request_submission_id_footers &&
|
|
939
|
-
ai_field_naming_language == o.ai_field_naming_language &&
|
|
940
|
-
allow_additional_properties == o.allow_additional_properties &&
|
|
941
|
-
allow_skipping_optional_fields == o.allow_skipping_optional_fields &&
|
|
942
|
-
default_form_mode == o.default_form_mode &&
|
|
943
|
-
editable_submissions == o.editable_submissions &&
|
|
944
|
-
embed_domains == o.embed_domains &&
|
|
945
|
-
embed_edit_allow_settings == o.embed_edit_allow_settings &&
|
|
946
|
-
embed_edit_allow_versioning == o.embed_edit_allow_versioning &&
|
|
947
|
-
embed_edit_allow_document_replacement == o.embed_edit_allow_document_replacement &&
|
|
948
|
-
encrypt_pdfs == o.encrypt_pdfs &&
|
|
949
|
-
has_encrypt_pdfs_password == o.has_encrypt_pdfs_password &&
|
|
950
|
-
expire_submissions == o.expire_submissions &&
|
|
951
|
-
expire_after == o.expire_after &&
|
|
952
|
-
expiration_interval == o.expiration_interval &&
|
|
953
|
-
merge_audit_trail_pdf == o.merge_audit_trail_pdf &&
|
|
954
|
-
parse_dates_using_template_date_format == o.parse_dates_using_template_date_format &&
|
|
955
|
-
public_submissions == o.public_submissions &&
|
|
956
|
-
public_web_form == o.public_web_form &&
|
|
957
|
-
redirect_url == o.redirect_url &&
|
|
958
|
-
has_slack_webhook_url == o.has_slack_webhook_url &&
|
|
959
420
|
last_changed_at == o.last_changed_at &&
|
|
960
|
-
last_changed_by == o.last_changed_by &&
|
|
961
421
|
created_at == o.created_at &&
|
|
962
422
|
updated_at == o.updated_at
|
|
963
423
|
end
|
|
@@ -971,7 +431,7 @@ module DocSpring
|
|
|
971
431
|
# Calculates hash code according to all attributes.
|
|
972
432
|
# @return [Integer] Hash code
|
|
973
433
|
def hash
|
|
974
|
-
[id, name, description, template_type, ready, document, parent_folder_id, path,
|
|
434
|
+
[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].hash
|
|
975
435
|
end
|
|
976
436
|
|
|
977
437
|
# Builds the object from hash
|