docspring 4.5.0 → 4.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +38 -0
- data/README.md +1 -1
- data/lib/docspring/api/client.rb +10 -4
- data/lib/docspring/api_client.rb +1 -1
- data/lib/docspring/models/combined_pdf.rb +1 -1
- data/lib/docspring/models/create_account_email_action_request.rb +1 -1
- data/lib/docspring/models/create_combined_pdf_request.rb +1 -1
- data/lib/docspring/models/create_email_action_request.rb +1 -1
- data/lib/docspring/models/create_submission_request.rb +5 -5
- data/lib/docspring/models/create_template_request.rb +76 -12
- data/lib/docspring/models/email_action.rb +1 -1
- data/lib/docspring/models/error_info.rb +1 -1
- data/lib/docspring/models/field.rb +166 -3
- data/lib/docspring/models/field_input.rb +77 -3
- data/lib/docspring/models/field_override.rb +55 -2
- data/lib/docspring/models/generated_file.rb +2 -2
- data/lib/docspring/models/number_part.rb +42 -0
- data/lib/docspring/models/predefined_field.rb +14 -1
- data/lib/docspring/models/predefined_field_input.rb +14 -1
- data/lib/docspring/models/signature_request.rb +3 -3
- data/lib/docspring/models/signature_request_input.rb +3 -10
- data/lib/docspring/models/submission.rb +3 -3
- data/lib/docspring/models/submission_files.rb +11 -1
- data/lib/docspring/models/submission_input.rb +2 -2
- data/lib/docspring/models/submission_summary.rb +1 -1
- data/lib/docspring/models/template.rb +154 -15
- data/lib/docspring/models/template_defaults.rb +1 -1
- data/lib/docspring/models/template_defaults_input.rb +1 -1
- data/lib/docspring/models/template_signer_role.rb +265 -0
- data/lib/docspring/models/template_signer_role_input.rb +227 -0
- data/lib/docspring/models/update_account_email_action_request.rb +1 -1
- data/lib/docspring/models/update_email_action_customization_request.rb +1 -1
- data/lib/docspring/models/update_email_action_request.rb +1 -1
- data/lib/docspring/models/update_template_document_request.rb +14 -4
- data/lib/docspring/models/update_template_request.rb +80 -16
- data/lib/docspring/models/validate_submission_request.rb +5 -5
- data/lib/docspring/request_schemas.json +278 -12
- data/lib/docspring/version.rb +1 -1
- data/lib/docspring.rb +3 -0
- metadata +5 -591
- data/.github/workflows/release.yml +0 -80
- data/.gitignore +0 -39
- data/.openapi-generator/FILES +0 -593
- data/.openapi-generator/VERSION +0 -1
- data/.openapi-generator-ignore +0 -23
- data/.rspec +0 -2
- data/.rubocop.yml +0 -148
- data/Gemfile +0 -9
- data/Gemfile.lock +0 -146
- data/Rakefile +0 -10
- data/docs/AddTemplateFieldsRequest.md +0 -18
- data/docs/AiFieldNamingLanguage.md +0 -15
- data/docs/AuthenticationCheck.md +0 -18
- data/docs/BarcodeSymbology.md +0 -15
- data/docs/CheckCharacter.md +0 -15
- data/docs/Client.md +0 -5890
- data/docs/CombinedFieldType.md +0 -15
- data/docs/CombinedPdf.md +0 -44
- data/docs/CombinedPdfFiles.md +0 -18
- data/docs/CombinedPdfList.md +0 -20
- data/docs/CombinedPdfSource.md +0 -26
- data/docs/CombinedPdfSourceInput.md +0 -88
- data/docs/CombinedPdfSourcePdf.md +0 -20
- data/docs/CombinedPdfSourceType.md +0 -15
- data/docs/CombinedPdfState.md +0 -15
- data/docs/CopyTemplateRequest.md +0 -22
- data/docs/CreateAccountEmailActionRequest.md +0 -54
- data/docs/CreateCombinedPdfRequest.md +0 -26
- data/docs/CreateCustomFileFromUploadRequest.md +0 -18
- data/docs/CreateEmailActionRequest.md +0 -50
- data/docs/CreateEmailDomainRequest.md +0 -18
- data/docs/CreateFolderRequest.md +0 -20
- data/docs/CreateSignatureRequestEventRequest.md +0 -24
- data/docs/CreateSignatureRequestTokenRequest.md +0 -18
- data/docs/CreateSubmissionBatchRequest.md +0 -28
- data/docs/CreateSubmissionRequest.md +0 -56
- data/docs/CreateTemplatePreviewRequest.md +0 -18
- data/docs/CreateTemplateRequest.md +0 -130
- data/docs/CreateWebhookRequest.md +0 -38
- data/docs/CustomFile.md +0 -28
- data/docs/CustomFileList.md +0 -20
- data/docs/CustomFileSourcePdf.md +0 -20
- data/docs/DnsRecordType.md +0 -15
- data/docs/EmailAction.md +0 -76
- data/docs/EmailActionConditions.md +0 -20
- data/docs/EmailActionConditionsInput.md +0 -20
- data/docs/EmailActionCustomization.md +0 -36
- data/docs/EmailActionDelivery.md +0 -15
- data/docs/EmailActionFileFormats.md +0 -15
- data/docs/EmailActionList.md +0 -20
- data/docs/EmailActionSetting.md +0 -15
- data/docs/EmailActionSubmissionType.md +0 -15
- data/docs/EmailActionTestEmail.md +0 -18
- data/docs/EmailDomain.md +0 -38
- data/docs/EmailDomainDnsRecord.md +0 -24
- data/docs/EmailDomainDnsRecordPurpose.md +0 -15
- data/docs/EmailDomainList.md +0 -20
- data/docs/EmailDomainRecordState.md +0 -15
- data/docs/EmailDomainState.md +0 -15
- data/docs/ErrorCode.md +0 -15
- data/docs/ErrorDetail.md +0 -26
- data/docs/ErrorInfo.md +0 -42
- data/docs/ErrorResponse.md +0 -18
- data/docs/ExpirationInterval.md +0 -15
- data/docs/Field.md +0 -198
- data/docs/FieldComparisonCondition.md +0 -22
- data/docs/FieldComparisonOperator.md +0 -15
- data/docs/FieldDependency.md +0 -22
- data/docs/FieldDependencyInput.md +0 -22
- data/docs/FieldDisplayType.md +0 -15
- data/docs/FieldEqualsCondition.md +0 -22
- data/docs/FieldEqualsOperator.md +0 -15
- data/docs/FieldGroup.md +0 -32
- data/docs/FieldGroupInput.md +0 -30
- data/docs/FieldGroupType.md +0 -15
- data/docs/FieldInCondition.md +0 -22
- data/docs/FieldInput.md +0 -196
- data/docs/FieldOverride.md +0 -142
- data/docs/FieldPresenceCondition.md +0 -20
- data/docs/FieldPresenceOperator.md +0 -15
- data/docs/FieldRangeCondition.md +0 -24
- data/docs/FieldReimportState.md +0 -15
- data/docs/FieldSetupLogic.md +0 -15
- data/docs/FieldSetupNaming.md +0 -15
- data/docs/FieldSetupSource.md +0 -15
- data/docs/FieldType.md +0 -15
- data/docs/Folder.md +0 -28
- data/docs/FolderList.md +0 -20
- data/docs/GenerateFilesFormat.md +0 -15
- data/docs/GenerateSubmissionFilesRequest.md +0 -18
- data/docs/GeneratedFile.md +0 -32
- data/docs/GeneratedFileState.md +0 -15
- data/docs/HtmlEngineOptions.md +0 -36
- data/docs/HtmlEngineOptionsInput.md +0 -36
- data/docs/ImageGravity.md +0 -15
- data/docs/ImageScaleType.md +0 -15
- data/docs/ModelCodeLanguage.md +0 -15
- data/docs/MoveFolderRequest.md +0 -18
- data/docs/MoveTemplateRequest.md +0 -18
- data/docs/NumberConditionType.md +0 -15
- data/docs/OutputFormat.md +0 -15
- data/docs/PageFormat.md +0 -15
- data/docs/PageImage.md +0 -34
- data/docs/PageImages.md +0 -24
- data/docs/PredefinedField.md +0 -30
- data/docs/PredefinedFieldInput.md +0 -30
- data/docs/PublishTemplateVersionRequest.md +0 -20
- data/docs/RemoveTemplateFieldsRequest.md +0 -18
- data/docs/RenameFolderRequest.md +0 -18
- data/docs/ReorderTemplateFieldsRequest.md +0 -18
- data/docs/RestoreTemplateVersionRequest.md +0 -18
- data/docs/SendAccountEmailActionTestEmailRequest.md +0 -18
- data/docs/ShapeType.md +0 -15
- data/docs/SignatureRequest.md +0 -74
- data/docs/SignatureRequestAuthSecondFactorType.md +0 -15
- data/docs/SignatureRequestAuthType.md +0 -15
- data/docs/SignatureRequestEmailAttachments.md +0 -15
- data/docs/SignatureRequestEmailStatus.md +0 -15
- data/docs/SignatureRequestEvent.md +0 -32
- data/docs/SignatureRequestEventType.md +0 -15
- data/docs/SignatureRequestInput.md +0 -50
- data/docs/SignatureRequestMessageType.md +0 -15
- data/docs/SignatureRequestReminders.md +0 -20
- data/docs/SignatureRequestState.md +0 -15
- data/docs/SignatureRequestToken.md +0 -30
- data/docs/SignatureRequestTokenType.md +0 -15
- data/docs/SigningOrder.md +0 -15
- data/docs/StringConditionType.md +0 -15
- data/docs/Submission.md +0 -68
- data/docs/SubmissionAction.md +0 -30
- data/docs/SubmissionActionState.md +0 -15
- data/docs/SubmissionActionType.md +0 -15
- data/docs/SubmissionBatch.md +0 -38
- data/docs/SubmissionBatchState.md +0 -15
- data/docs/SubmissionFiles.md +0 -28
- data/docs/SubmissionInput.md +0 -40
- data/docs/SubmissionList.md +0 -20
- data/docs/SubmissionSource.md +0 -15
- data/docs/SubmissionSourcePdf.md +0 -20
- data/docs/SubmissionState.md +0 -15
- data/docs/SubmissionSummary.md +0 -54
- data/docs/SubmissionValidation.md +0 -24
- data/docs/Template.md +0 -142
- data/docs/TemplateActor.md +0 -26
- data/docs/TemplateActorType.md +0 -15
- data/docs/TemplateDefaults.md +0 -56
- data/docs/TemplateDefaultsInput.md +0 -56
- data/docs/TemplateDiff.md +0 -30
- data/docs/TemplateDiffSummary.md +0 -28
- data/docs/TemplateDocument.md +0 -40
- data/docs/TemplateDocumentState.md +0 -15
- data/docs/TemplateDocumentSummary.md +0 -24
- data/docs/TemplateFieldChange.md +0 -24
- data/docs/TemplateFieldChanges.md +0 -24
- data/docs/TemplateFieldDependency.md +0 -26
- data/docs/TemplateFieldDependencyAction.md +0 -15
- data/docs/TemplateFieldDependencyCondition.md +0 -24
- data/docs/TemplateFieldDependencyConditionInput.md +0 -93
- data/docs/TemplateFieldDependencyInput.md +0 -26
- data/docs/TemplateFieldDependencyMatch.md +0 -15
- data/docs/TemplateFieldDependencyOperator.md +0 -15
- data/docs/TemplateFieldLogicStatus.md +0 -15
- data/docs/TemplateFieldMove.md +0 -22
- data/docs/TemplateFields.md +0 -22
- data/docs/TemplateFormMode.md +0 -15
- data/docs/TemplateFormSection.md +0 -24
- data/docs/TemplateFormSectionInput.md +0 -24
- data/docs/TemplateModelCode.md +0 -22
- data/docs/TemplatePageAiError.md +0 -15
- data/docs/TemplatePageAiNamingStatus.md +0 -15
- data/docs/TemplatePageFieldsStatus.md +0 -15
- data/docs/TemplatePageImageStatus.md +0 -15
- data/docs/TemplatePageImages.md +0 -24
- data/docs/TemplatePageProcessingStatus.md +0 -26
- data/docs/TemplatePreview.md +0 -32
- data/docs/TemplatePreviewState.md +0 -15
- data/docs/TemplateSourcePdf.md +0 -24
- data/docs/TemplateSummary.md +0 -46
- data/docs/TemplateSummaryList.md +0 -20
- data/docs/TemplateType.md +0 -15
- data/docs/TemplateVersion.md +0 -24
- data/docs/TemplateVersionType.md +0 -15
- data/docs/TextAlignment.md +0 -15
- data/docs/TextOverflow.md +0 -15
- data/docs/TextVerticalAlignment.md +0 -15
- data/docs/Typeface.md +0 -15
- data/docs/UpdateAccountEmailActionRequest.md +0 -54
- data/docs/UpdateEmailActionCustomizationRequest.md +0 -46
- data/docs/UpdateEmailActionRequest.md +0 -50
- data/docs/UpdateSignatureRequestRequest.md +0 -34
- data/docs/UpdateTemplateDocumentRequest.md +0 -26
- data/docs/UpdateTemplateFieldsRequest.md +0 -18
- data/docs/UpdateTemplateRequest.md +0 -114
- data/docs/UpdateWebhookRequest.md +0 -38
- data/docs/UploadMethod.md +0 -15
- data/docs/UploadPresign.md +0 -24
- data/docs/UrlSourcePdf.md +0 -20
- data/docs/ValidateSubmissionRequest.md +0 -56
- data/docs/Webhook.md +0 -56
- data/docs/WebhookEventType.md +0 -15
- data/docs/WebhookList.md +0 -20
- data/docs/WebhookMode.md +0 -15
- data/docspring.gemspec +0 -40
- data/spec/api/client_spec.rb +0 -1103
- data/spec/models/add_template_fields_request_spec.rb +0 -36
- data/spec/models/ai_field_naming_language_spec.rb +0 -30
- data/spec/models/authentication_check_spec.rb +0 -36
- data/spec/models/barcode_symbology_spec.rb +0 -30
- data/spec/models/check_character_spec.rb +0 -30
- data/spec/models/combined_field_type_spec.rb +0 -30
- data/spec/models/combined_pdf_files_spec.rb +0 -36
- data/spec/models/combined_pdf_list_spec.rb +0 -42
- data/spec/models/combined_pdf_source_input_spec.rb +0 -44
- data/spec/models/combined_pdf_source_pdf_spec.rb +0 -42
- data/spec/models/combined_pdf_source_spec.rb +0 -60
- data/spec/models/combined_pdf_source_type_spec.rb +0 -30
- data/spec/models/combined_pdf_spec.rb +0 -114
- data/spec/models/combined_pdf_state_spec.rb +0 -30
- data/spec/models/copy_template_request_spec.rb +0 -48
- data/spec/models/create_account_email_action_request_spec.rb +0 -144
- data/spec/models/create_combined_pdf_request_spec.rb +0 -60
- data/spec/models/create_custom_file_from_upload_request_spec.rb +0 -36
- data/spec/models/create_email_action_request_spec.rb +0 -132
- data/spec/models/create_email_domain_request_spec.rb +0 -36
- data/spec/models/create_folder_request_spec.rb +0 -42
- data/spec/models/create_signature_request_event_request_spec.rb +0 -54
- data/spec/models/create_signature_request_token_request_spec.rb +0 -36
- data/spec/models/create_submission_batch_request_spec.rb +0 -66
- data/spec/models/create_submission_request_spec.rb +0 -150
- data/spec/models/create_template_preview_request_spec.rb +0 -36
- data/spec/models/create_template_request_spec.rb +0 -372
- data/spec/models/create_webhook_request_spec.rb +0 -96
- data/spec/models/custom_file_list_spec.rb +0 -42
- data/spec/models/custom_file_source_pdf_spec.rb +0 -42
- data/spec/models/custom_file_spec.rb +0 -66
- data/spec/models/dns_record_type_spec.rb +0 -30
- data/spec/models/email_action_conditions_input_spec.rb +0 -42
- data/spec/models/email_action_conditions_spec.rb +0 -42
- data/spec/models/email_action_customization_spec.rb +0 -90
- data/spec/models/email_action_delivery_spec.rb +0 -30
- data/spec/models/email_action_file_formats_spec.rb +0 -30
- data/spec/models/email_action_list_spec.rb +0 -42
- data/spec/models/email_action_setting_spec.rb +0 -30
- data/spec/models/email_action_spec.rb +0 -210
- data/spec/models/email_action_submission_type_spec.rb +0 -30
- data/spec/models/email_action_test_email_spec.rb +0 -36
- data/spec/models/email_domain_dns_record_purpose_spec.rb +0 -30
- data/spec/models/email_domain_dns_record_spec.rb +0 -54
- data/spec/models/email_domain_list_spec.rb +0 -42
- data/spec/models/email_domain_record_state_spec.rb +0 -30
- data/spec/models/email_domain_spec.rb +0 -96
- data/spec/models/email_domain_state_spec.rb +0 -30
- data/spec/models/error_code_spec.rb +0 -30
- data/spec/models/error_detail_spec.rb +0 -60
- data/spec/models/error_info_spec.rb +0 -108
- data/spec/models/error_response_spec.rb +0 -36
- data/spec/models/expiration_interval_spec.rb +0 -30
- data/spec/models/field_comparison_condition_spec.rb +0 -48
- data/spec/models/field_comparison_operator_spec.rb +0 -30
- data/spec/models/field_dependency_input_spec.rb +0 -48
- data/spec/models/field_dependency_spec.rb +0 -48
- data/spec/models/field_display_type_spec.rb +0 -30
- data/spec/models/field_equals_condition_spec.rb +0 -48
- data/spec/models/field_equals_operator_spec.rb +0 -30
- data/spec/models/field_group_input_spec.rb +0 -72
- data/spec/models/field_group_spec.rb +0 -78
- data/spec/models/field_group_type_spec.rb +0 -30
- data/spec/models/field_in_condition_spec.rb +0 -48
- data/spec/models/field_input_spec.rb +0 -570
- data/spec/models/field_override_spec.rb +0 -408
- data/spec/models/field_presence_condition_spec.rb +0 -42
- data/spec/models/field_presence_operator_spec.rb +0 -30
- data/spec/models/field_range_condition_spec.rb +0 -54
- data/spec/models/field_reimport_state_spec.rb +0 -30
- data/spec/models/field_setup_logic_spec.rb +0 -30
- data/spec/models/field_setup_naming_spec.rb +0 -30
- data/spec/models/field_setup_source_spec.rb +0 -30
- data/spec/models/field_spec.rb +0 -576
- data/spec/models/field_type_spec.rb +0 -30
- data/spec/models/folder_list_spec.rb +0 -42
- data/spec/models/folder_spec.rb +0 -66
- data/spec/models/generate_files_format_spec.rb +0 -30
- data/spec/models/generate_submission_files_request_spec.rb +0 -36
- data/spec/models/generated_file_spec.rb +0 -78
- data/spec/models/generated_file_state_spec.rb +0 -30
- data/spec/models/html_engine_options_input_spec.rb +0 -90
- data/spec/models/html_engine_options_spec.rb +0 -90
- data/spec/models/image_gravity_spec.rb +0 -30
- data/spec/models/image_scale_type_spec.rb +0 -30
- data/spec/models/model_code_language_spec.rb +0 -30
- data/spec/models/move_folder_request_spec.rb +0 -36
- data/spec/models/move_template_request_spec.rb +0 -36
- data/spec/models/number_condition_type_spec.rb +0 -30
- data/spec/models/output_format_spec.rb +0 -30
- data/spec/models/page_format_spec.rb +0 -30
- data/spec/models/page_image_spec.rb +0 -84
- data/spec/models/page_images_spec.rb +0 -54
- data/spec/models/predefined_field_input_spec.rb +0 -72
- data/spec/models/predefined_field_spec.rb +0 -72
- data/spec/models/publish_template_version_request_spec.rb +0 -42
- data/spec/models/remove_template_fields_request_spec.rb +0 -36
- data/spec/models/rename_folder_request_spec.rb +0 -36
- data/spec/models/reorder_template_fields_request_spec.rb +0 -36
- data/spec/models/restore_template_version_request_spec.rb +0 -36
- data/spec/models/send_account_email_action_test_email_request_spec.rb +0 -36
- data/spec/models/shape_type_spec.rb +0 -30
- data/spec/models/signature_request_auth_second_factor_type_spec.rb +0 -30
- data/spec/models/signature_request_auth_type_spec.rb +0 -30
- data/spec/models/signature_request_email_attachments_spec.rb +0 -30
- data/spec/models/signature_request_email_status_spec.rb +0 -30
- data/spec/models/signature_request_event_spec.rb +0 -78
- data/spec/models/signature_request_event_type_spec.rb +0 -30
- data/spec/models/signature_request_input_spec.rb +0 -132
- data/spec/models/signature_request_message_type_spec.rb +0 -30
- data/spec/models/signature_request_reminders_spec.rb +0 -42
- data/spec/models/signature_request_spec.rb +0 -204
- data/spec/models/signature_request_state_spec.rb +0 -30
- data/spec/models/signature_request_token_spec.rb +0 -72
- data/spec/models/signature_request_token_type_spec.rb +0 -30
- data/spec/models/signing_order_spec.rb +0 -30
- data/spec/models/string_condition_type_spec.rb +0 -30
- data/spec/models/submission_action_spec.rb +0 -72
- data/spec/models/submission_action_state_spec.rb +0 -30
- data/spec/models/submission_action_type_spec.rb +0 -30
- data/spec/models/submission_batch_spec.rb +0 -96
- data/spec/models/submission_batch_state_spec.rb +0 -30
- data/spec/models/submission_files_spec.rb +0 -66
- data/spec/models/submission_input_spec.rb +0 -102
- data/spec/models/submission_list_spec.rb +0 -42
- data/spec/models/submission_source_pdf_spec.rb +0 -42
- data/spec/models/submission_source_spec.rb +0 -30
- data/spec/models/submission_spec.rb +0 -186
- data/spec/models/submission_state_spec.rb +0 -30
- data/spec/models/submission_summary_spec.rb +0 -144
- data/spec/models/submission_validation_spec.rb +0 -54
- data/spec/models/template_actor_spec.rb +0 -60
- data/spec/models/template_actor_type_spec.rb +0 -30
- data/spec/models/template_defaults_input_spec.rb +0 -150
- data/spec/models/template_defaults_spec.rb +0 -150
- data/spec/models/template_diff_spec.rb +0 -72
- data/spec/models/template_diff_summary_spec.rb +0 -66
- data/spec/models/template_document_spec.rb +0 -102
- data/spec/models/template_document_state_spec.rb +0 -30
- data/spec/models/template_document_summary_spec.rb +0 -54
- data/spec/models/template_field_change_spec.rb +0 -54
- data/spec/models/template_field_changes_spec.rb +0 -54
- data/spec/models/template_field_dependency_action_spec.rb +0 -30
- data/spec/models/template_field_dependency_condition_input_spec.rb +0 -44
- data/spec/models/template_field_dependency_condition_spec.rb +0 -54
- data/spec/models/template_field_dependency_input_spec.rb +0 -60
- data/spec/models/template_field_dependency_match_spec.rb +0 -30
- data/spec/models/template_field_dependency_operator_spec.rb +0 -30
- data/spec/models/template_field_dependency_spec.rb +0 -60
- data/spec/models/template_field_logic_status_spec.rb +0 -30
- data/spec/models/template_field_move_spec.rb +0 -48
- data/spec/models/template_fields_spec.rb +0 -48
- data/spec/models/template_form_mode_spec.rb +0 -30
- data/spec/models/template_form_section_input_spec.rb +0 -54
- data/spec/models/template_form_section_spec.rb +0 -54
- data/spec/models/template_model_code_spec.rb +0 -48
- data/spec/models/template_page_ai_error_spec.rb +0 -30
- data/spec/models/template_page_ai_naming_status_spec.rb +0 -30
- data/spec/models/template_page_fields_status_spec.rb +0 -30
- data/spec/models/template_page_image_status_spec.rb +0 -30
- data/spec/models/template_page_images_spec.rb +0 -54
- data/spec/models/template_page_processing_status_spec.rb +0 -60
- data/spec/models/template_preview_spec.rb +0 -78
- data/spec/models/template_preview_state_spec.rb +0 -30
- data/spec/models/template_source_pdf_spec.rb +0 -54
- data/spec/models/template_spec.rb +0 -408
- data/spec/models/template_summary_list_spec.rb +0 -42
- data/spec/models/template_summary_spec.rb +0 -120
- data/spec/models/template_type_spec.rb +0 -30
- data/spec/models/template_version_spec.rb +0 -54
- data/spec/models/template_version_type_spec.rb +0 -30
- data/spec/models/text_alignment_spec.rb +0 -30
- data/spec/models/text_overflow_spec.rb +0 -30
- data/spec/models/text_vertical_alignment_spec.rb +0 -30
- data/spec/models/typeface_spec.rb +0 -30
- data/spec/models/update_account_email_action_request_spec.rb +0 -144
- data/spec/models/update_email_action_customization_request_spec.rb +0 -120
- data/spec/models/update_email_action_request_spec.rb +0 -132
- data/spec/models/update_signature_request_request_spec.rb +0 -84
- data/spec/models/update_template_document_request_spec.rb +0 -60
- data/spec/models/update_template_fields_request_spec.rb +0 -36
- data/spec/models/update_template_request_spec.rb +0 -324
- data/spec/models/update_webhook_request_spec.rb +0 -96
- data/spec/models/upload_method_spec.rb +0 -30
- data/spec/models/upload_presign_spec.rb +0 -54
- data/spec/models/url_source_pdf_spec.rb +0 -42
- data/spec/models/validate_submission_request_spec.rb +0 -150
- data/spec/models/webhook_event_type_spec.rb +0 -30
- data/spec/models/webhook_list_spec.rb +0 -42
- data/spec/models/webhook_mode_spec.rb +0 -30
- data/spec/models/webhook_spec.rb +0 -150
- data/spec/spec_helper.rb +0 -111
data/docs/Template.md
DELETED
|
@@ -1,142 +0,0 @@
|
|
|
1
|
-
# DocSpring::Template
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | The template's ID. | |
|
|
8
|
-
| **name** | **String** | The template's name. | |
|
|
9
|
-
| **description** | **String** | 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. | |
|
|
10
|
-
| **template_type** | [**TemplateType**](TemplateType.md) | `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. `page_designer`: a page design, a PDF laid out in the Page Designer from its `layout`. It can't be changed after the template is created. | |
|
|
11
|
-
| **output_format** | [**OutputFormat**](OutputFormat.md) | 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; other templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected. | |
|
|
12
|
-
| **ready** | **Boolean** | Whether the template can make documents. HTML templates and page designs 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). | |
|
|
13
|
-
| **document** | [**TemplateDocument**](TemplateDocument.md) | 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. | |
|
|
14
|
-
| **parent_folder_id** | **String** | 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. | |
|
|
15
|
-
| **path** | **String** | The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root. | |
|
|
16
|
-
| **latest_version** | **String** | The template's latest published version. Null if no version has been published. | |
|
|
17
|
-
| **version_published_at** | **Time** | When this version was published. Null for the draft. | |
|
|
18
|
-
| **locked** | **Boolean** | A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed). | |
|
|
19
|
-
| **last_changed_at** | **Time** | When the draft was last changed. | |
|
|
20
|
-
| **created_at** | **Time** | When the template was created. | |
|
|
21
|
-
| **updated_at** | **Time** | When the template was last updated. | |
|
|
22
|
-
| **version** | **String** | The published version this is, such as `1.2.0`. Null for the draft. | |
|
|
23
|
-
| **add_signature_request_submission_id_footers** | **Boolean** | Print the submission ID in the footer of each page of PDFs signed through signature requests. | |
|
|
24
|
-
| **ai_field_naming_language** | [**AiFieldNamingLanguage**](AiFieldNamingLanguage.md) | 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. | |
|
|
25
|
-
| **allow_additional_properties** | **Boolean** | Accept submission data with properties that aren't fields of the template. | |
|
|
26
|
-
| **allow_skipping_optional_fields** | **Boolean** | 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. | |
|
|
27
|
-
| **default_form_mode** | [**TemplateFormMode**](TemplateFormMode.md) | 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`. | |
|
|
28
|
-
| **editable_submissions** | **Boolean** | Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it. | |
|
|
29
|
-
| **embed_domains** | **Array<String>** | 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), without a path. Each one is stored in lowercase, without a trailing slash. Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and Web Forms JS) aren't restricted. | |
|
|
30
|
-
| **embed_edit_allow_settings** | **Boolean** | Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on). | |
|
|
31
|
-
| **embed_edit_allow_versioning** | **Boolean** | Allow the embedded template editor to publish, restore, compare and delete published versions. | |
|
|
32
|
-
| **embed_edit_allow_document_replacement** | **Boolean** | Allow the embedded template editor to replace the template's PDF. | |
|
|
33
|
-
| **encrypt_pdfs** | **Boolean** | 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. | |
|
|
34
|
-
| **has_encrypt_pdfs_password** | **Boolean** | Whether `encrypt_pdfs_password` is set. | |
|
|
35
|
-
| **expire_submissions** | **Boolean** | Delete each submission's data and PDF after `expire_after` `expiration_interval`. | |
|
|
36
|
-
| **expire_after** | **Integer** | 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). | |
|
|
37
|
-
| **expiration_interval** | [**ExpirationInterval**](ExpirationInterval.md) | The unit of `expire_after`. | |
|
|
38
|
-
| **merge_audit_trail_pdf** | **Boolean** | Add the audit trail to the end of PDFs signed through signature requests. | |
|
|
39
|
-
| **parse_dates_using_template_date_format** | **Boolean** | 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. | |
|
|
40
|
-
| **public_submissions** | **Boolean** | Allow anyone with a submission's ID to download its PDF. | |
|
|
41
|
-
| **public_web_form** | **Boolean** | Allow anyone to fill in the template's web form. | |
|
|
42
|
-
| **redirect_url** | **String** | Where the web form sends people after they submit it, instead of showing its success screen. After its `?` or `#`, it can have variables such as `{{ data.first_name }}`, which the form fills in with what they submitted. | |
|
|
43
|
-
| **signature_request_email_attachments** | [**SignatureRequestEmailAttachments**](SignatureRequestEmailAttachments.md) | How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. PDF templates only. A signature request uses the value it had when the request was created. | |
|
|
44
|
-
| **signature_request_from_address** | **String** | The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name. PDF templates only. | |
|
|
45
|
-
| **signature_request_include_signing_token** | **Boolean** | Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign. PDF templates only. | |
|
|
46
|
-
| **signature_request_from_name** | **String** | The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name. PDF templates only. | |
|
|
47
|
-
| **signature_request_notification_emails** | **Array<String>** | Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them. PDF templates only. | |
|
|
48
|
-
| **signature_request_reply_to** | **String** | Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it. PDF templates only. | |
|
|
49
|
-
| **signature_request_signing_url** | **String** | A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page. PDF templates only. | |
|
|
50
|
-
| **success_title** | **String** | The title of the web form's success screen. When it's null or empty, the screen says "Thanks for filling out" and the template's name. It can have variables such as `{{ data.first_name }}`. | |
|
|
51
|
-
| **success_message** | **String** | A message under the title of the web form's success screen, as plain text. Line breaks show, and web addresses become links. It can have variables such as `{{ data.first_name }}`. | |
|
|
52
|
-
| **show_fill_again_button** | **Boolean** | Whether the web form's success screen has a "Fill out again" button, which clears the form so someone can fill it in again. | |
|
|
53
|
-
| **has_slack_webhook_url** | **Boolean** | Whether `slack_webhook_url` is set. | |
|
|
54
|
-
| **last_changed_by** | [**TemplateActor**](TemplateActor.md) | 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. | |
|
|
55
|
-
| **defaults** | [**TemplateDefaults**](TemplateDefaults.md) | | |
|
|
56
|
-
| **field_dependencies** | [**Array<TemplateFieldDependency>**](TemplateFieldDependency.md) | Conditional logic: each rule shows or hides its target fields, or makes them required, depending on the values of other fields. | |
|
|
57
|
-
| **field_groups** | [**Array<FieldGroup>**](FieldGroup.md) | The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`. | |
|
|
58
|
-
| **form_sections** | [**Array<TemplateFormSection>**](TemplateFormSection.md) | The web form's sections, in order: Web Forms JS and the hosted web form show one section at a time. Empty when the template has none, and the web form shows all of its fields together, in the order the fields endpoint lists them. A field that no section lists (one added later) goes after the field before it in that order, in that field's section. | |
|
|
59
|
-
| **predefined_fields** | [**Array<PredefinedField>**](PredefinedField.md) | The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off. | |
|
|
60
|
-
| **predefined_fields_sample_data** | **Hash<String, Object>** | 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. | |
|
|
61
|
-
| **html** | **String** | The HTML of an HTML template, as a Liquid template. Null for other templates. | |
|
|
62
|
-
| **scss** | **String** | The SCSS of an HTML template. | |
|
|
63
|
-
| **header_html** | **String** | The HTML printed at the top of each page of an HTML template. | |
|
|
64
|
-
| **footer_html** | **String** | The HTML printed at the bottom of each page of an HTML template. | |
|
|
65
|
-
| **html_engine_options** | [**HtmlEngineOptions**](HtmlEngineOptions.md) | How an HTML template's PDFs are printed. Null for other templates. Setting it replaces the whole object: options left out use their defaults. | |
|
|
66
|
-
| **html_escape_data** | **Boolean** | 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 other templates. | |
|
|
67
|
-
| **layout** | **Hash<String, Object>** | A page design's layout: its page setup, its sections and the elements placed in them, in the Page Designer layout format (https://docspring.com/docs/page-designer/layout-format/). Its JSON Schema is at https://docspring.com/schemas/page-designer/layout.v1.json. Null for other templates. Setting it replaces the whole layout, and DocSpring adds a field for each value it reads. Left out when a page design is created, it starts with an empty page. | |
|
|
68
|
-
| **embed_edit_token** | **String** | The token that opens the template in the embedded template editor. | |
|
|
69
|
-
| **versions** | [**Array<TemplateVersion>**](TemplateVersion.md) | The template's published versions, newest first (up to 100). | |
|
|
70
|
-
|
|
71
|
-
## Example
|
|
72
|
-
|
|
73
|
-
```ruby
|
|
74
|
-
require 'docspring'
|
|
75
|
-
|
|
76
|
-
instance = DocSpring::Template.new(
|
|
77
|
-
id: null,
|
|
78
|
-
name: null,
|
|
79
|
-
description: null,
|
|
80
|
-
template_type: null,
|
|
81
|
-
output_format: null,
|
|
82
|
-
ready: null,
|
|
83
|
-
document: null,
|
|
84
|
-
parent_folder_id: null,
|
|
85
|
-
path: null,
|
|
86
|
-
latest_version: null,
|
|
87
|
-
version_published_at: null,
|
|
88
|
-
locked: null,
|
|
89
|
-
last_changed_at: null,
|
|
90
|
-
created_at: null,
|
|
91
|
-
updated_at: null,
|
|
92
|
-
version: null,
|
|
93
|
-
add_signature_request_submission_id_footers: null,
|
|
94
|
-
ai_field_naming_language: null,
|
|
95
|
-
allow_additional_properties: null,
|
|
96
|
-
allow_skipping_optional_fields: null,
|
|
97
|
-
default_form_mode: null,
|
|
98
|
-
editable_submissions: null,
|
|
99
|
-
embed_domains: null,
|
|
100
|
-
embed_edit_allow_settings: null,
|
|
101
|
-
embed_edit_allow_versioning: null,
|
|
102
|
-
embed_edit_allow_document_replacement: null,
|
|
103
|
-
encrypt_pdfs: null,
|
|
104
|
-
has_encrypt_pdfs_password: null,
|
|
105
|
-
expire_submissions: null,
|
|
106
|
-
expire_after: null,
|
|
107
|
-
expiration_interval: null,
|
|
108
|
-
merge_audit_trail_pdf: null,
|
|
109
|
-
parse_dates_using_template_date_format: null,
|
|
110
|
-
public_submissions: null,
|
|
111
|
-
public_web_form: null,
|
|
112
|
-
redirect_url: null,
|
|
113
|
-
signature_request_email_attachments: null,
|
|
114
|
-
signature_request_from_address: null,
|
|
115
|
-
signature_request_include_signing_token: null,
|
|
116
|
-
signature_request_from_name: null,
|
|
117
|
-
signature_request_notification_emails: null,
|
|
118
|
-
signature_request_reply_to: null,
|
|
119
|
-
signature_request_signing_url: null,
|
|
120
|
-
success_title: null,
|
|
121
|
-
success_message: null,
|
|
122
|
-
show_fill_again_button: null,
|
|
123
|
-
has_slack_webhook_url: null,
|
|
124
|
-
last_changed_by: null,
|
|
125
|
-
defaults: null,
|
|
126
|
-
field_dependencies: null,
|
|
127
|
-
field_groups: null,
|
|
128
|
-
form_sections: null,
|
|
129
|
-
predefined_fields: null,
|
|
130
|
-
predefined_fields_sample_data: null,
|
|
131
|
-
html: null,
|
|
132
|
-
scss: null,
|
|
133
|
-
header_html: null,
|
|
134
|
-
footer_html: null,
|
|
135
|
-
html_engine_options: null,
|
|
136
|
-
html_escape_data: null,
|
|
137
|
-
layout: null,
|
|
138
|
-
embed_edit_token: null,
|
|
139
|
-
versions: null
|
|
140
|
-
)
|
|
141
|
-
```
|
|
142
|
-
|
data/docs/TemplateActor.md
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateActor
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | [**TemplateActorType**](TemplateActorType.md) | `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. | |
|
|
8
|
-
| **user_id** | **String** | The user's ID, for `user`. | |
|
|
9
|
-
| **external_id** | **String** | The ID your app gave the embedded editor's user, for `external_user`. | |
|
|
10
|
-
| **name** | **String** | The user's name, or the name your app gave the embedded editor's user. | |
|
|
11
|
-
| **email** | **String** | The email address your app gave the embedded editor's user, for `external_user`. | |
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'docspring'
|
|
17
|
-
|
|
18
|
-
instance = DocSpring::TemplateActor.new(
|
|
19
|
-
type: null,
|
|
20
|
-
user_id: null,
|
|
21
|
-
external_id: null,
|
|
22
|
-
name: null,
|
|
23
|
-
email: null
|
|
24
|
-
)
|
|
25
|
-
```
|
|
26
|
-
|
data/docs/TemplateActorType.md
DELETED
data/docs/TemplateDefaults.md
DELETED
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateDefaults
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **typeface** | [**Typeface**](Typeface.md) | The font of text fields. | [optional] |
|
|
8
|
-
| **font_size** | **Float** | The font size in points, a whole number. | [optional] |
|
|
9
|
-
| **character_spacing** | **Float** | Extra space between characters, in points (0 to 50). | [optional] |
|
|
10
|
-
| **color** | **String** | The text color, as 6 hex digits without `#`, such as `444444`. | [optional] |
|
|
11
|
-
| **background_color** | **String** | The field's background color, as 6 hex digits. | [optional] |
|
|
12
|
-
| **bold** | **Boolean** | Print text in bold. | [optional] |
|
|
13
|
-
| **uppercase** | **Boolean** | Print text in capital letters. | [optional] |
|
|
14
|
-
| **alignment** | [**TextAlignment**](TextAlignment.md) | How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph. | [optional] |
|
|
15
|
-
| **opacity** | **Float** | The opacity of the field's content, from 0 (invisible) to 1. | [optional] |
|
|
16
|
-
| **date_format** | **String** | How date fields are printed, as a strftime format such as `%m/%d/%Y`. | [optional] |
|
|
17
|
-
| **date_time_format** | **String** | How date-time fields are printed, as a strftime format such as `%m/%d/%Y %H:%M:%S`. | [optional] |
|
|
18
|
-
| **check_color** | **String** | The color of check marks, as 6 hex digits. | [optional] |
|
|
19
|
-
| **check_character** | [**CheckCharacter**](CheckCharacter.md) | The character that a ticked check box prints. | [optional] |
|
|
20
|
-
| **check_background_color** | **String** | The check box's background color, as 6 hex digits. | [optional] |
|
|
21
|
-
| **required_field_background_color** | **String** | The background color that highlights required fields on visual forms and signature request forms, as 6 hex digits. PDFs don't print it. | [optional] |
|
|
22
|
-
| **true_text** | **String** | The text a boolean field prints for `true`. | [optional] |
|
|
23
|
-
| **false_text** | **String** | The text a boolean field prints for `false`. | [optional] |
|
|
24
|
-
| **shape_fill_color** | **String** | The fill color of shapes, as 6 hex digits. | [optional] |
|
|
25
|
-
| **shape_border_color** | **String** | The border color of shapes, as 6 hex digits. | [optional] |
|
|
26
|
-
| **shape_border_width** | **Float** | The border width of shapes, in whole points (at least 1). | [optional] |
|
|
27
|
-
|
|
28
|
-
## Example
|
|
29
|
-
|
|
30
|
-
```ruby
|
|
31
|
-
require 'docspring'
|
|
32
|
-
|
|
33
|
-
instance = DocSpring::TemplateDefaults.new(
|
|
34
|
-
typeface: null,
|
|
35
|
-
font_size: null,
|
|
36
|
-
character_spacing: null,
|
|
37
|
-
color: null,
|
|
38
|
-
background_color: null,
|
|
39
|
-
bold: null,
|
|
40
|
-
uppercase: null,
|
|
41
|
-
alignment: null,
|
|
42
|
-
opacity: null,
|
|
43
|
-
date_format: null,
|
|
44
|
-
date_time_format: null,
|
|
45
|
-
check_color: null,
|
|
46
|
-
check_character: null,
|
|
47
|
-
check_background_color: null,
|
|
48
|
-
required_field_background_color: null,
|
|
49
|
-
true_text: null,
|
|
50
|
-
false_text: null,
|
|
51
|
-
shape_fill_color: null,
|
|
52
|
-
shape_border_color: null,
|
|
53
|
-
shape_border_width: null
|
|
54
|
-
)
|
|
55
|
-
```
|
|
56
|
-
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateDefaultsInput
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **typeface** | [**Typeface**](Typeface.md) | The font of text fields. | [optional] |
|
|
8
|
-
| **font_size** | **Integer** | The font size in points, a whole number. | [optional] |
|
|
9
|
-
| **character_spacing** | **Float** | Extra space between characters, in points (0 to 50). | [optional] |
|
|
10
|
-
| **color** | **String** | The text color, as 6 hex digits without `#`, such as `444444`. | [optional] |
|
|
11
|
-
| **background_color** | **String** | The field's background color, as 6 hex digits. | [optional] |
|
|
12
|
-
| **bold** | **Boolean** | Print text in bold. | [optional] |
|
|
13
|
-
| **uppercase** | **Boolean** | Print text in capital letters. | [optional] |
|
|
14
|
-
| **alignment** | [**TextAlignment**](TextAlignment.md) | How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph. | [optional] |
|
|
15
|
-
| **opacity** | **Float** | The opacity of the field's content, from 0 (invisible) to 1. | [optional] |
|
|
16
|
-
| **date_format** | **String** | How date fields are printed, as a strftime format such as `%m/%d/%Y`. | [optional] |
|
|
17
|
-
| **date_time_format** | **String** | How date-time fields are printed, as a strftime format such as `%m/%d/%Y %H:%M:%S`. | [optional] |
|
|
18
|
-
| **check_color** | **String** | The color of check marks, as 6 hex digits. | [optional] |
|
|
19
|
-
| **check_character** | [**CheckCharacter**](CheckCharacter.md) | The character that a ticked check box prints. | [optional] |
|
|
20
|
-
| **check_background_color** | **String** | The check box's background color, as 6 hex digits. | [optional] |
|
|
21
|
-
| **required_field_background_color** | **String** | The background color that highlights required fields on visual forms and signature request forms, as 6 hex digits. PDFs don't print it. | [optional] |
|
|
22
|
-
| **true_text** | **String** | The text a boolean field prints for `true`. | [optional] |
|
|
23
|
-
| **false_text** | **String** | The text a boolean field prints for `false`. | [optional] |
|
|
24
|
-
| **shape_fill_color** | **String** | The fill color of shapes, as 6 hex digits. | [optional] |
|
|
25
|
-
| **shape_border_color** | **String** | The border color of shapes, as 6 hex digits. | [optional] |
|
|
26
|
-
| **shape_border_width** | **Integer** | The border width of shapes, in whole points (at least 1). | [optional] |
|
|
27
|
-
|
|
28
|
-
## Example
|
|
29
|
-
|
|
30
|
-
```ruby
|
|
31
|
-
require 'docspring'
|
|
32
|
-
|
|
33
|
-
instance = DocSpring::TemplateDefaultsInput.new(
|
|
34
|
-
typeface: null,
|
|
35
|
-
font_size: null,
|
|
36
|
-
character_spacing: null,
|
|
37
|
-
color: null,
|
|
38
|
-
background_color: null,
|
|
39
|
-
bold: null,
|
|
40
|
-
uppercase: null,
|
|
41
|
-
alignment: null,
|
|
42
|
-
opacity: null,
|
|
43
|
-
date_format: null,
|
|
44
|
-
date_time_format: null,
|
|
45
|
-
check_color: null,
|
|
46
|
-
check_character: null,
|
|
47
|
-
check_background_color: null,
|
|
48
|
-
required_field_background_color: null,
|
|
49
|
-
true_text: null,
|
|
50
|
-
false_text: null,
|
|
51
|
-
shape_fill_color: null,
|
|
52
|
-
shape_border_color: null,
|
|
53
|
-
shape_border_width: null
|
|
54
|
-
)
|
|
55
|
-
```
|
|
56
|
-
|
data/docs/TemplateDiff.md
DELETED
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateDiff
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **template_id** | **String** | The template's ID. | |
|
|
8
|
-
| **from_version** | **String** | The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added. | |
|
|
9
|
-
| **to_version** | **String** | The later version, such as `1.2.0`. Null for the draft. | |
|
|
10
|
-
| **summary** | [**TemplateDiffSummary**](TemplateDiffSummary.md) | How many changes of each kind there are. | |
|
|
11
|
-
| **fields** | [**TemplateFieldChanges**](TemplateFieldChanges.md) | The fields that changed. | |
|
|
12
|
-
| **changed_settings** | **Array<String>** | 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. | |
|
|
13
|
-
| **document_changed** | **Boolean** | The template's PDF was replaced, or its Word document replaced or edited (or added, when there's no `from_version`). | |
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```ruby
|
|
18
|
-
require 'docspring'
|
|
19
|
-
|
|
20
|
-
instance = DocSpring::TemplateDiff.new(
|
|
21
|
-
template_id: null,
|
|
22
|
-
from_version: null,
|
|
23
|
-
to_version: null,
|
|
24
|
-
summary: null,
|
|
25
|
-
fields: null,
|
|
26
|
-
changed_settings: null,
|
|
27
|
-
document_changed: null
|
|
28
|
-
)
|
|
29
|
-
```
|
|
30
|
-
|
data/docs/TemplateDiffSummary.md
DELETED
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateDiffSummary
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **fields_added** | **Integer** | How many fields were added. | |
|
|
8
|
-
| **fields_removed** | **Integer** | How many fields were removed. | |
|
|
9
|
-
| **fields_changed** | **Integer** | How many fields have changed settings. | |
|
|
10
|
-
| **fields_reordered** | **Integer** | How many fields moved in the template's field order. | |
|
|
11
|
-
| **settings_changed** | **Integer** | How many of the template's settings changed. | |
|
|
12
|
-
| **total_changes** | **Integer** | All the changes, counting a new document as one. Zero when the versions are the same. | |
|
|
13
|
-
|
|
14
|
-
## Example
|
|
15
|
-
|
|
16
|
-
```ruby
|
|
17
|
-
require 'docspring'
|
|
18
|
-
|
|
19
|
-
instance = DocSpring::TemplateDiffSummary.new(
|
|
20
|
-
fields_added: null,
|
|
21
|
-
fields_removed: null,
|
|
22
|
-
fields_changed: null,
|
|
23
|
-
fields_reordered: null,
|
|
24
|
-
settings_changed: null,
|
|
25
|
-
total_changes: null
|
|
26
|
-
)
|
|
27
|
-
```
|
|
28
|
-
|
data/docs/TemplateDocument.md
DELETED
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateDocument
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **filename** | **String** | The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted. | |
|
|
8
|
-
| **state** | [**TemplateDocumentState**](TemplateDocumentState.md) | `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted. | |
|
|
9
|
-
| **error_message** | **String** | Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error. | |
|
|
10
|
-
| **page_count** | **Integer** | 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data. | |
|
|
11
|
-
| **md5** | **String** | The MD5 hash of the PDF. Null for a Word document. | |
|
|
12
|
-
| **field_reimport_state** | [**FieldReimportState**](FieldReimportState.md) | Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was). | |
|
|
13
|
-
| **page_dimensions** | **Array<Array<Float>>** | Each page's width and height in PDF points. Null until the PDF has been processed. | |
|
|
14
|
-
| **has_fillable_fields** | **Boolean** | Whether the PDF has fillable form fields. Null until DocSpring has read the PDF, and for a Word document. | |
|
|
15
|
-
| **page_processing_statuses** | [**Array<TemplatePageProcessingStatus>**](TemplatePageProcessingStatus.md) | How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, for PDFs uploaded before DocSpring recorded page statuses, and for a Word document. | |
|
|
16
|
-
| **field_logic_status** | [**TemplateFieldLogicStatus**](TemplateFieldLogicStatus.md) | AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields). Null for a Word document. | |
|
|
17
|
-
| **download_url** | **String** | A temporary link to download the PDF. Null for a Word document (use `permanent_url`). | |
|
|
18
|
-
| **permanent_url** | **String** | A link to download the file that doesn't expire. Null until a PDF has been processed. A Word document's is built from the template's current document when it's downloaded. | |
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
```ruby
|
|
23
|
-
require 'docspring'
|
|
24
|
-
|
|
25
|
-
instance = DocSpring::TemplateDocument.new(
|
|
26
|
-
filename: null,
|
|
27
|
-
state: null,
|
|
28
|
-
error_message: null,
|
|
29
|
-
page_count: null,
|
|
30
|
-
md5: null,
|
|
31
|
-
field_reimport_state: null,
|
|
32
|
-
page_dimensions: null,
|
|
33
|
-
has_fillable_fields: null,
|
|
34
|
-
page_processing_statuses: null,
|
|
35
|
-
field_logic_status: null,
|
|
36
|
-
download_url: null,
|
|
37
|
-
permanent_url: null
|
|
38
|
-
)
|
|
39
|
-
```
|
|
40
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateDocumentState
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplateDocumentState.new()
|
|
14
|
-
```
|
|
15
|
-
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateDocumentSummary
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **filename** | **String** | The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted. | |
|
|
8
|
-
| **state** | [**TemplateDocumentState**](TemplateDocumentState.md) | `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted. | |
|
|
9
|
-
| **error_message** | **String** | Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error. | |
|
|
10
|
-
| **page_count** | **Integer** | 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data. | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateDocumentSummary.new(
|
|
18
|
-
filename: null,
|
|
19
|
-
state: null,
|
|
20
|
-
error_message: null,
|
|
21
|
-
page_count: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
data/docs/TemplateFieldChange.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldChange
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | The field's ID. | |
|
|
8
|
-
| **changed_settings** | **Array<String>** | The names of the settings that changed, such as `x` or `required`. | |
|
|
9
|
-
| **old** | [**Field**](Field.md) | | |
|
|
10
|
-
| **new** | [**Field**](Field.md) | | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateFieldChange.new(
|
|
18
|
-
id: null,
|
|
19
|
-
changed_settings: null,
|
|
20
|
-
old: null,
|
|
21
|
-
new: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldChanges
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **added** | [**Array<Field>**](Field.md) | The fields that `to_version` has and `from_version` doesn't. | |
|
|
8
|
-
| **removed** | [**Array<Field>**](Field.md) | The fields that `from_version` has and `to_version` doesn't, as they were. | |
|
|
9
|
-
| **changed** | [**Array<TemplateFieldChange>**](TemplateFieldChange.md) | The fields with changed settings. | |
|
|
10
|
-
| **reordered** | [**Array<TemplateFieldMove>**](TemplateFieldMove.md) | The fields that moved in the template's field order (the order of its fields across all its pages, as the fields endpoint lists them): fields that swapped places, or the field that moved the furthest. The fields that a move pushed along aren't listed. | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateFieldChanges.new(
|
|
18
|
-
added: null,
|
|
19
|
-
removed: null,
|
|
20
|
-
changed: null,
|
|
21
|
-
reordered: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldDependency
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to the fields it applies to when its conditions are met. | |
|
|
8
|
-
| **match** | [**TemplateFieldDependencyMatch**](TemplateFieldDependencyMatch.md) | Whether all of the conditions (the default) or any of them must be met. | [optional] |
|
|
9
|
-
| **conditions** | [**Array<TemplateFieldDependencyCondition>**](TemplateFieldDependencyCondition.md) | The conditions on other fields' values. | |
|
|
10
|
-
| **targets** | **Array<String>** | The names of the fields the rule shows or makes required. | |
|
|
11
|
-
| **group** | **String** | Marks a rule made for a field group in the template editor. Its targets outside the group are removed when the template is saved, and the rule is removed once the group has no fields. | [optional] |
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'docspring'
|
|
17
|
-
|
|
18
|
-
instance = DocSpring::TemplateFieldDependency.new(
|
|
19
|
-
action: null,
|
|
20
|
-
match: null,
|
|
21
|
-
conditions: null,
|
|
22
|
-
targets: null,
|
|
23
|
-
group: null
|
|
24
|
-
)
|
|
25
|
-
```
|
|
26
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldDependencyAction
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplateFieldDependencyAction.new()
|
|
14
|
-
```
|
|
15
|
-
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldDependencyCondition
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **field** | **String** | The name of the field whose value is compared. | |
|
|
8
|
-
| **operator** | [**TemplateFieldDependencyOperator**](TemplateFieldDependencyOperator.md) | How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`. | |
|
|
9
|
-
| **value** | **Object** | The value to compare the field's value with. | [optional] |
|
|
10
|
-
| **range_max** | **Object** | The upper end of a `range`, a number (or a number as a string, as the template editor saves it). | [optional] |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateFieldDependencyCondition.new(
|
|
18
|
-
field: null,
|
|
19
|
-
operator: null,
|
|
20
|
-
value: null,
|
|
21
|
-
range_max: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|