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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eee786640ec87ba91001348710e07b5ec9cd36d730e5e7b89e7e750484fe5e92
|
|
4
|
+
data.tar.gz: 512c77c3e4e6baa619c184646cdd326c2f97ed71c94a0fc2506f4a9bedcbb258
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ec22f0f19c9ab21cb3870a36473057d7cefd97a21c24db91a1ead4e0996ec3106d736f5a0a6d95bbddd0a7975f58a1e60ae9693fe1afc108988937bd7d767e30
|
|
7
|
+
data.tar.gz: 29f7da10125fb8190388bda99b6b22da64be000a3a87ae87067e8648fd0d9f2941b17f48772bbe3e4c0fa154e8f673680cef8b8bafde101f76f3709d804c7484
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,41 @@
|
|
|
1
|
+
### 4.6.0 [November 17, 2026]
|
|
2
|
+
|
|
3
|
+
- New: `Field` has `comb_fill_from_right`, `comb_pad_with_zeros` and `print_digits_only`, which set how a comb
|
|
4
|
+
field's value fills its boxes: from the right, padded with zeros, or with only its digits (so `123-45-6789` fills an
|
|
5
|
+
SSN's 9 boxes). `FieldOverride` takes `comb_fill_from_right` and `comb_pad_with_zeros`.
|
|
6
|
+
- New: `Field` has `number_part`, which part of a number the field prints: `all`, `whole` or `decimals`, so one amount
|
|
7
|
+
fills a dollars field and a cents field. `FieldOverride` takes it too.
|
|
8
|
+
- New: `Field` has `option_labels`, the label forms show for each of its options, keyed by the option, such as
|
|
9
|
+
`{"married_filing_jointly": "Married filing jointly"}` (the data keeps the option), and `print_option_labels`, which
|
|
10
|
+
prints the chosen option's label on the PDF instead of the option. `FieldOverride` takes both, and `PredefinedField`
|
|
11
|
+
takes `option_labels`.
|
|
12
|
+
- New: `Template` has `override_account_expiry`, which create_template and update_template take too: whether the
|
|
13
|
+
template's own expiry (`expire_submissions`, `expire_after` and `expiration_interval`) decides when its submissions
|
|
14
|
+
are deleted, or your account's data retention settings do. Creating a template with `expire_submissions` turns it on.
|
|
15
|
+
- New: `SubmissionFiles` has `signing_manifest`, the audit data behind a signed submission's audit trail, as JSON.
|
|
16
|
+
- Changed: without `expires_in`, a submission follows its template's expiry, or your account's data retention settings
|
|
17
|
+
when the template doesn't override them, and a combined PDF follows your account's settings.
|
|
18
|
+
- New: `Template` has `form_sections_in_order`, whether a web form with sections makes people fill them out in order, which create_template and update_template take too.
|
|
19
|
+
- New: `Template` has `continue_before_optional_fields`, whether visual forms and signature requests show Continue
|
|
20
|
+
next to Next as soon as the required fields are filled in (on by default), which create_template and update_template take too.
|
|
21
|
+
`allow_skipping_optional_fields` is now only for pages on Visual Forms JS 2.16.0 to 2.23.0.
|
|
22
|
+
- New: signature requests on HTML templates, Word templates and page designs. DocSpring makes the document when you
|
|
23
|
+
create the signature requests, and signers fill in its form fields. See [how they
|
|
24
|
+
work](https://docspring.com/docs/forms/signature-requests/#html-templates-word-templates-and-page-designs).
|
|
25
|
+
- Changed: a signature request's `fields` (`SignatureRequestInput`) is optional. A signature request with a `role` gets
|
|
26
|
+
the fields the template gives that role, and a submission's only signature request can leave out both: it gets every
|
|
27
|
+
field without a role that `data` doesn't fill in.
|
|
28
|
+
- New: `Template` has `signer_roles`, the people who sign its submissions (`TemplateSignerRole`: an `id`, a `key`, a
|
|
29
|
+
`name`, and a `name_expression` and an `email_expression` for a signature request that doesn't give a name or email
|
|
30
|
+
address), and `signature_request_cc`, who gets a copy of the completed document. create_template and update_template
|
|
31
|
+
take them too.
|
|
32
|
+
- New: a field has `signer_role`, the key of the signer role that fills it in or signs it, or `sender` for a field that
|
|
33
|
+
`data` fills in. add_template_fields and update_template_fields take it too.
|
|
34
|
+
- New: create_template, upload_template, update_template, update_template_document and upload_template_document take
|
|
35
|
+
`sync_fields` (default true): an HTML template's code, a Word template's document or a page design's layout adds a
|
|
36
|
+
field for each value it reads for the first time. A Word template takes it with its document
|
|
37
|
+
(update_template_document and upload_template_document), not update_template.
|
|
38
|
+
|
|
1
39
|
### 4.5.0 [November 7, 2026]
|
|
2
40
|
|
|
3
41
|
- New: `Template` has `form_sections`, the web form's sections in order (`TemplateFormSection`: an `id`, a `title`, a
|
data/README.md
CHANGED
|
@@ -13,7 +13,7 @@ pull requests are welcome.
|
|
|
13
13
|
Outside Ruby code, the [DocSpring CLI](https://docspring.com/docs/cli/) calls the same API from a terminal or a
|
|
14
14
|
shell script, and the [MCP server](https://docspring.com/docs/mcp/) connects AI assistants to your account.
|
|
15
15
|
|
|
16
|
-
Version 4.
|
|
16
|
+
Version 4.6.0. Requires Ruby >= 2.7.
|
|
17
17
|
|
|
18
18
|
## Install and configure
|
|
19
19
|
|
data/lib/docspring/api/client.rb
CHANGED
|
@@ -1592,7 +1592,7 @@ end
|
|
|
1592
1592
|
end
|
|
1593
1593
|
|
|
1594
1594
|
# Delete a template
|
|
1595
|
-
# Deletes a template's draft and all of its published versions, or one published version (`version`). Returns the template as it was before it was deleted.
|
|
1595
|
+
# Deletes a template's draft and all of its published versions, or one published version (`version`). Returns the template as it was before it was deleted. A deleted template can be restored from Trash in the dashboard for a limited time; a single deleted version can't.
|
|
1596
1596
|
# @param template_id [String] The template's ID.
|
|
1597
1597
|
# @param [Hash] opts the optional parameters
|
|
1598
1598
|
# @option opts [String] :version Delete only this published version (`1.2.0`) or the draft (`draft`, when no version has been published). Without it, the draft and every published version are deleted.
|
|
@@ -1604,7 +1604,7 @@ end
|
|
|
1604
1604
|
end
|
|
1605
1605
|
|
|
1606
1606
|
# Delete a template
|
|
1607
|
-
# Deletes a template's draft and all of its published versions, or one published version (`version`). Returns the template as it was before it was deleted.
|
|
1607
|
+
# Deletes a template's draft and all of its published versions, or one published version (`version`). Returns the template as it was before it was deleted. A deleted template can be restored from Trash in the dashboard for a limited time; a single deleted version can't.
|
|
1608
1608
|
# @param template_id [String] The template's ID.
|
|
1609
1609
|
# @param [Hash] opts the optional parameters
|
|
1610
1610
|
# @option opts [String] :version Delete only this published version (`1.2.0`) or the draft (`draft`, when no version has been published). Without it, the draft and every published version are deleted.
|
|
@@ -1793,7 +1793,7 @@ end
|
|
|
1793
1793
|
end
|
|
1794
1794
|
|
|
1795
1795
|
# Expire a submission
|
|
1796
|
-
# Deletes a submission's data and
|
|
1796
|
+
# Deletes a submission's data and files now, along with any signature requests and audit trail, and returns the expired submission.
|
|
1797
1797
|
# @param submission_id [String] The submission's ID.
|
|
1798
1798
|
# @param [Hash] opts the optional parameters
|
|
1799
1799
|
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
@@ -1804,7 +1804,7 @@ end
|
|
|
1804
1804
|
end
|
|
1805
1805
|
|
|
1806
1806
|
# Expire a submission
|
|
1807
|
-
# Deletes a submission's data and
|
|
1807
|
+
# Deletes a submission's data and files now, along with any signature requests and audit trail, and returns the expired submission.
|
|
1808
1808
|
# @param submission_id [String] The submission's ID.
|
|
1809
1809
|
# @param [Hash] opts the optional parameters
|
|
1810
1810
|
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
@@ -5267,6 +5267,7 @@ end
|
|
|
5267
5267
|
# @option opts [FieldSetupLogic] :field_logic With `detect_fields`, whether AI reads the whole form once the fields are named and sets up conditional logic and required fields (`ai`) or not (`none`). Default: your account's template settings.
|
|
5268
5268
|
# @option opts [OutputFormat] :output_format What each submission of a Word template makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. Required when `document` is a Word document.
|
|
5269
5269
|
# @option opts [Boolean] :include_office_use_fields With `detect_fields`, whether AI field setup keeps the fields that only the office receiving the form fills in, such as a "For office use only" box (`true`), or leaves them out (`false`). Default: your account's template settings.
|
|
5270
|
+
# @option opts [Boolean] :sync_fields Add a field for each value the template's code, Word document or layout reads for the first time, with a type worked out from how it's used. Existing fields keep their settings, and a field you deleted while the code still read the value stays deleted. Default true. Set it to false to manage the fields yourself with the fields endpoints: a form field whose field isn't on the template then fails its submissions and previews. Only for HTML templates, Word templates and page designs.
|
|
5270
5271
|
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5271
5272
|
# @return [Template]
|
|
5272
5273
|
def upload_template(document, opts = {})
|
|
@@ -5289,6 +5290,7 @@ end
|
|
|
5289
5290
|
# @option opts [FieldSetupLogic] :field_logic With `detect_fields`, whether AI reads the whole form once the fields are named and sets up conditional logic and required fields (`ai`) or not (`none`). Default: your account's template settings.
|
|
5290
5291
|
# @option opts [OutputFormat] :output_format What each submission of a Word template makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. Required when `document` is a Word document.
|
|
5291
5292
|
# @option opts [Boolean] :include_office_use_fields With `detect_fields`, whether AI field setup keeps the fields that only the office receiving the form fills in, such as a "For office use only" box (`true`), or leaves them out (`false`). Default: your account's template settings.
|
|
5293
|
+
# @option opts [Boolean] :sync_fields Add a field for each value the template's code, Word document or layout reads for the first time, with a type worked out from how it's used. Existing fields keep their settings, and a field you deleted while the code still read the value stays deleted. Default true. Set it to false to manage the fields yourself with the fields endpoints: a form field whose field isn't on the template then fails its submissions and previews. Only for HTML templates, Word templates and page designs.
|
|
5292
5294
|
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5293
5295
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
5294
5296
|
def upload_template_with_http_info(document, opts = {})
|
|
@@ -5330,6 +5332,7 @@ end
|
|
|
5330
5332
|
form_params['field_logic'] = opts[:'field_logic'] if !opts[:'field_logic'].nil?
|
|
5331
5333
|
form_params['output_format'] = opts[:'output_format'] if !opts[:'output_format'].nil?
|
|
5332
5334
|
form_params['include_office_use_fields'] = opts[:'include_office_use_fields'] if !opts[:'include_office_use_fields'].nil?
|
|
5335
|
+
form_params['sync_fields'] = opts[:'sync_fields'] if !opts[:'sync_fields'].nil?
|
|
5333
5336
|
|
|
5334
5337
|
# http body (model)
|
|
5335
5338
|
post_body = opts[:debug_body]
|
|
@@ -5364,6 +5367,7 @@ end
|
|
|
5364
5367
|
# @param [Hash] opts the optional parameters
|
|
5365
5368
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
5366
5369
|
# @option opts [Boolean] :reimport_fields Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
|
|
5370
|
+
# @option opts [Boolean] :sync_fields Add a field for each value the template's code, Word document or layout reads for the first time, with a type worked out from how it's used. Existing fields keep their settings, and a field you deleted while the code still read the value stays deleted. Default true. Set it to false to manage the fields yourself with the fields endpoints: a form field whose field isn't on the template then fails its submissions and previews. Only for HTML templates, Word templates and page designs.
|
|
5367
5371
|
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5368
5372
|
# @return [Template]
|
|
5369
5373
|
def upload_template_document(template_id, document, opts = {})
|
|
@@ -5378,6 +5382,7 @@ end
|
|
|
5378
5382
|
# @param [Hash] opts the optional parameters
|
|
5379
5383
|
# @option opts [Boolean] :wait Wait until the PDF has been processed, a `document_url`'s PDF or Word document downloaded, and an OpenDocument file converted, before responding. Default true on sync.api hosts.
|
|
5380
5384
|
# @option opts [Boolean] :reimport_fields Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
|
|
5385
|
+
# @option opts [Boolean] :sync_fields Add a field for each value the template's code, Word document or layout reads for the first time, with a type worked out from how it's used. Existing fields keep their settings, and a field you deleted while the code still read the value stays deleted. Default true. Set it to false to manage the fields yourself with the fields endpoints: a form field whose field isn't on the template then fails its submissions and previews. Only for HTML templates, Word templates and page designs.
|
|
5381
5386
|
# @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of processing it again. Send a new key with each new request, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` with a `Retry-After` header means the first request is still being processed: send the request again then. A repeated response is the first one as it was, so its `download_url` links may have expired: use `permanent_url`, or get the record again for new links.
|
|
5382
5387
|
# @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
|
|
5383
5388
|
def upload_template_document_with_http_info(template_id, document, opts = {})
|
|
@@ -5414,6 +5419,7 @@ end
|
|
|
5414
5419
|
form_params = opts[:form_params] || {}
|
|
5415
5420
|
form_params['document'] = document
|
|
5416
5421
|
form_params['reimport_fields'] = opts[:'reimport_fields'] if !opts[:'reimport_fields'].nil?
|
|
5422
|
+
form_params['sync_fields'] = opts[:'sync_fields'] if !opts[:'sync_fields'].nil?
|
|
5417
5423
|
|
|
5418
5424
|
# http body (model)
|
|
5419
5425
|
post_body = opts[:debug_body]
|
data/lib/docspring/api_client.rb
CHANGED
|
@@ -34,7 +34,7 @@ module DocSpring
|
|
|
34
34
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
|
35
35
|
def initialize(config = Configuration.default)
|
|
36
36
|
@config = config
|
|
37
|
-
@user_agent = "docspring-ruby-4.
|
|
37
|
+
@user_agent = "docspring-ruby-4.6.0"
|
|
38
38
|
@default_headers = {
|
|
39
39
|
'Content-Type' => 'application/json',
|
|
40
40
|
'User-Agent' => @user_agent
|
|
@@ -46,7 +46,7 @@ module DocSpring
|
|
|
46
46
|
# An expired combined PDF's PDF, metadata, password and source URLs have been deleted.
|
|
47
47
|
attr_accessor :expired
|
|
48
48
|
|
|
49
|
-
# When the combined PDF expires (`expires_in
|
|
49
|
+
# When the combined PDF expires (`expires_in`, or the account's expiry setting, after it's generated). Null if it's kept until you delete it.
|
|
50
50
|
attr_accessor :expires_at
|
|
51
51
|
|
|
52
52
|
# When the PDF was generated. Null until then.
|
|
@@ -58,7 +58,7 @@ module DocSpring
|
|
|
58
58
|
# Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
|
|
59
59
|
attr_accessor :file_formats
|
|
60
60
|
|
|
61
|
-
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
|
|
61
|
+
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days, or until the submission expires if that's sooner. Accounts with a BAA start with `link`.
|
|
62
62
|
attr_accessor :delivery
|
|
63
63
|
|
|
64
64
|
# With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
|
|
@@ -28,7 +28,7 @@ module DocSpring
|
|
|
28
28
|
# Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files.
|
|
29
29
|
attr_accessor :delete_custom_files
|
|
30
30
|
|
|
31
|
-
# Seconds after the PDF is generated until the combined PDF expires, up to 10 years (315360000)
|
|
31
|
+
# Seconds after the PDF is generated until the combined PDF expires, up to 10 years (315360000), sooner or later than the account's expiry setting. Defaults to the account's expiry setting, which keeps it until you delete it when it's off. One that fails is kept for at least 48 hours.
|
|
32
32
|
attr_accessor :expires_in
|
|
33
33
|
|
|
34
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -52,7 +52,7 @@ module DocSpring
|
|
|
52
52
|
# Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
|
|
53
53
|
attr_accessor :file_formats
|
|
54
54
|
|
|
55
|
-
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
|
|
55
|
+
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days, or until the submission expires if that's sooner. Accounts with a BAA start with `link`.
|
|
56
56
|
attr_accessor :delivery
|
|
57
57
|
|
|
58
58
|
# With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
|
|
@@ -22,7 +22,7 @@ module DocSpring
|
|
|
22
22
|
# `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
|
|
23
23
|
attr_accessor :editable
|
|
24
24
|
|
|
25
|
-
# The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them
|
|
25
|
+
# The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them. Signatures come only from signature requests: a value for a signature or initials field makes the submission `invalid_data`, in test mode too. To print an image or a name you send, use an Image or Text field.
|
|
26
26
|
attr_accessor :data
|
|
27
27
|
|
|
28
28
|
# Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
|
|
@@ -31,10 +31,10 @@ module DocSpring
|
|
|
31
31
|
# A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
|
|
32
32
|
attr_accessor :password
|
|
33
33
|
|
|
34
|
-
# What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
34
|
+
# What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. A Word template's submission with signature requests makes only `pdf`, which its signers sign. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
35
35
|
attr_accessor :output_formats
|
|
36
36
|
|
|
37
|
-
# Seconds after the
|
|
37
|
+
# Seconds after the submission is processed until it expires, up to 10 years (315360000), sooner or later than the template's or the account's expiry setting. Defaults to the template's expiry when it overrides the account's (`override_account_expiry`), and otherwise to the account's expiry setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
|
|
38
38
|
attr_accessor :expires_in
|
|
39
39
|
|
|
40
40
|
# Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. A `default` for a signature or initials field makes the submission `invalid_data`. With `signature_requests`, `editable: true` is a 422.
|
|
@@ -46,7 +46,7 @@ module DocSpring
|
|
|
46
46
|
# For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity.
|
|
47
47
|
attr_accessor :css
|
|
48
48
|
|
|
49
|
-
# The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF
|
|
49
|
+
# The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. The signers of an HTML template, a Word template or a page design fill in its form fields and signature tags in a PDF made from `data`, and a Word template's submission makes only a PDF. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out.
|
|
50
50
|
attr_accessor :signature_requests
|
|
51
51
|
|
|
52
52
|
# Whether DocSpring emails the signers their signing links, and sends the reminders and the completed document. Default true. Each signature request's own `send_email` overrides it. A test submission only emails your DocSpring team: every other address is a 422. `true` needs `signature_requests`. DocSpring doesn't email the signers of a form library template: leave `send_email` out, and send them their links yourself.
|
|
@@ -61,7 +61,7 @@ module DocSpring
|
|
|
61
61
|
# A message for the people who sign, shown above the signing button. It takes the same variables as `email_subject`. Links and web addresses are shown as plain text. Leave it out for none: a blank message is a 422.
|
|
62
62
|
attr_accessor :email_message
|
|
63
63
|
|
|
64
|
-
# People who get a copy of the completed document
|
|
64
|
+
# People who get a copy of the completed document, as well as the template's `signature_request_cc`. They don't sign.
|
|
65
65
|
attr_accessor :cc
|
|
66
66
|
|
|
67
67
|
# Where replies to the emails go: a member of your DocSpring team, or an address at one of your verified email domains. Leave it out for the template's reply-to address (the account owner when it has none).
|
|
@@ -43,16 +43,19 @@ module DocSpring
|
|
|
43
43
|
# Accept submission data with properties that aren't fields of the template.
|
|
44
44
|
attr_accessor :allow_additional_properties
|
|
45
45
|
|
|
46
|
-
# Visual
|
|
46
|
+
# Visual Forms JS 2.16.0 to 2.23.0 only: with it on, Continue takes the place of Next once the required fields are filled in. Later versions use `continue_before_optional_fields`.
|
|
47
47
|
attr_accessor :allow_skipping_optional_fields
|
|
48
48
|
|
|
49
|
+
# Visual forms and signature request forms show the Continue button next to Next as soon as the required fields are filled in, without visiting each optional field. Turned off, Continue shows in place of Next only once every field has a value or has been visited. The `allowSkippingOptionalFields` embed option overrides it.
|
|
50
|
+
attr_accessor :continue_before_optional_fields
|
|
51
|
+
|
|
49
52
|
# 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`.
|
|
50
53
|
attr_accessor :default_form_mode
|
|
51
54
|
|
|
52
55
|
# Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
|
|
53
56
|
attr_accessor :editable_submissions
|
|
54
57
|
|
|
55
|
-
# The sites that can embed the template's live signature requests
|
|
58
|
+
# The sites that can embed the template's live signature requests, its embedded template editor and its visual form: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work), without a path. Each one is stored in lowercase, without a trailing slash. Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. A visual form embedded with Visual Forms JS loads only on these sites, and on any site when the list is empty. Web Forms JS isn't restricted.
|
|
56
59
|
attr_accessor :embed_domains
|
|
57
60
|
|
|
58
61
|
# Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
|
|
@@ -70,10 +73,10 @@ module DocSpring
|
|
|
70
73
|
# The password that opens encrypted PDFs. It's never returned; `has_encrypt_pdfs_password` says if it's set.
|
|
71
74
|
attr_accessor :encrypt_pdfs_password
|
|
72
75
|
|
|
73
|
-
# Delete each submission's data and
|
|
76
|
+
# Delete each submission's data and files after `expire_after` `expiration_interval`, when `override_account_expiry` is on.
|
|
74
77
|
attr_accessor :expire_submissions
|
|
75
78
|
|
|
76
|
-
# How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions`
|
|
79
|
+
# How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` and `override_account_expiry` are on. At most 5256000 (10 years in minutes).
|
|
77
80
|
attr_accessor :expire_after
|
|
78
81
|
|
|
79
82
|
# The unit of `expire_after`.
|
|
@@ -94,25 +97,25 @@ module DocSpring
|
|
|
94
97
|
# 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.
|
|
95
98
|
attr_accessor :redirect_url
|
|
96
99
|
|
|
97
|
-
# How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached.
|
|
100
|
+
# How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. A signature request uses the value it had when the request was created.
|
|
98
101
|
attr_accessor :signature_request_email_attachments
|
|
99
102
|
|
|
100
|
-
# The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name.
|
|
103
|
+
# 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.
|
|
101
104
|
attr_accessor :signature_request_from_address
|
|
102
105
|
|
|
103
|
-
# Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign.
|
|
106
|
+
# 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.
|
|
104
107
|
attr_accessor :signature_request_include_signing_token
|
|
105
108
|
|
|
106
|
-
# The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name.
|
|
109
|
+
# 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.
|
|
107
110
|
attr_accessor :signature_request_from_name
|
|
108
111
|
|
|
109
|
-
# Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them.
|
|
112
|
+
# 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.
|
|
110
113
|
attr_accessor :signature_request_notification_emails
|
|
111
114
|
|
|
112
|
-
# Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it.
|
|
115
|
+
# 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.
|
|
113
116
|
attr_accessor :signature_request_reply_to
|
|
114
117
|
|
|
115
|
-
# A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page.
|
|
118
|
+
# 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.
|
|
116
119
|
attr_accessor :signature_request_signing_url
|
|
117
120
|
|
|
118
121
|
# 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 }}`.
|
|
@@ -124,6 +127,9 @@ module DocSpring
|
|
|
124
127
|
# Whether the web form's success screen has a "Fill out again" button, which clears the form so someone can fill it in again.
|
|
125
128
|
attr_accessor :show_fill_again_button
|
|
126
129
|
|
|
130
|
+
# Whether a web form with sections makes people fill them out in order. When true, a later section stays locked until they reach it with Next. When false, they can open any section from the list, and Next and Submit still check their answers.
|
|
131
|
+
attr_accessor :form_sections_in_order
|
|
132
|
+
|
|
127
133
|
# A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set.
|
|
128
134
|
attr_accessor :slack_webhook_url
|
|
129
135
|
|
|
@@ -133,6 +139,12 @@ module DocSpring
|
|
|
133
139
|
# The template's conditional logic rules. Setting them replaces all of the rules.
|
|
134
140
|
attr_accessor :field_dependencies
|
|
135
141
|
|
|
142
|
+
# The template's signer roles, in order. Setting them replaces the whole list: a role left out is deleted, and its fields are left unassigned. Give each role you keep its `id`.
|
|
143
|
+
attr_accessor :signer_roles
|
|
144
|
+
|
|
145
|
+
# Who gets a copy of the completed document when DocSpring emails a submission's signers, with the submission's `cc`: email addresses, or `{{ variables }}` that name an address in the submission's data, such as `{{ agent.email }}`. A value the data doesn't have prints nothing, and an address that comes out blank is left out. The data has to have the value, so it's one of the template's fields (one the sender fills in) or the template allows additional properties: setting a variable that isn't a field is a `422` otherwise. They don't sign. Setting it replaces the whole list.
|
|
146
|
+
attr_accessor :signature_request_cc
|
|
147
|
+
|
|
136
148
|
# 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.
|
|
137
149
|
attr_accessor :predefined_fields
|
|
138
150
|
|
|
@@ -160,6 +172,12 @@ module DocSpring
|
|
|
160
172
|
# 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.
|
|
161
173
|
attr_accessor :layout
|
|
162
174
|
|
|
175
|
+
# Whether the template's own expiry (`expire_submissions`, `expire_after` and `expiration_interval`) decides when all its submissions are deleted, with or without signature requests, including keeping them until you delete them. When false, the account's expiry settings do. Turning `expire_submissions` on also turns this on, unless the same request sets it, and so does creating a template with `expire_submissions` on or off.
|
|
176
|
+
attr_accessor :override_account_expiry
|
|
177
|
+
|
|
178
|
+
# Add a field for each value the template's code, Word document or layout reads for the first time, with a type worked out from how it's used. Existing fields keep their settings, and a field you deleted while the code still read the value stays deleted. Default true. Set it to false to manage the fields yourself with the fields endpoints: a form field whose field isn't on the template then fails its submissions and previews. Only for HTML templates, Word templates and page designs.
|
|
179
|
+
attr_accessor :sync_fields
|
|
180
|
+
|
|
163
181
|
# The template's document, a PDF or a Word document (.docx or .odt): the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). PDF and Word templates need one of `cache_id`, `document_url` and `document_base64`. To upload the file with the request, use POST /templates/upload.
|
|
164
182
|
attr_accessor :cache_id
|
|
165
183
|
|
|
@@ -222,6 +240,7 @@ module DocSpring
|
|
|
222
240
|
:'ai_field_naming_language' => :'ai_field_naming_language',
|
|
223
241
|
:'allow_additional_properties' => :'allow_additional_properties',
|
|
224
242
|
:'allow_skipping_optional_fields' => :'allow_skipping_optional_fields',
|
|
243
|
+
:'continue_before_optional_fields' => :'continue_before_optional_fields',
|
|
225
244
|
:'default_form_mode' => :'default_form_mode',
|
|
226
245
|
:'editable_submissions' => :'editable_submissions',
|
|
227
246
|
:'embed_domains' => :'embed_domains',
|
|
@@ -248,9 +267,12 @@ module DocSpring
|
|
|
248
267
|
:'success_title' => :'success_title',
|
|
249
268
|
:'success_message' => :'success_message',
|
|
250
269
|
:'show_fill_again_button' => :'show_fill_again_button',
|
|
270
|
+
:'form_sections_in_order' => :'form_sections_in_order',
|
|
251
271
|
:'slack_webhook_url' => :'slack_webhook_url',
|
|
252
272
|
:'defaults' => :'defaults',
|
|
253
273
|
:'field_dependencies' => :'field_dependencies',
|
|
274
|
+
:'signer_roles' => :'signer_roles',
|
|
275
|
+
:'signature_request_cc' => :'signature_request_cc',
|
|
254
276
|
:'predefined_fields' => :'predefined_fields',
|
|
255
277
|
:'predefined_fields_sample_data' => :'predefined_fields_sample_data',
|
|
256
278
|
:'html' => :'html',
|
|
@@ -260,6 +282,8 @@ module DocSpring
|
|
|
260
282
|
:'html_engine_options' => :'html_engine_options',
|
|
261
283
|
:'html_escape_data' => :'html_escape_data',
|
|
262
284
|
:'layout' => :'layout',
|
|
285
|
+
:'override_account_expiry' => :'override_account_expiry',
|
|
286
|
+
:'sync_fields' => :'sync_fields',
|
|
263
287
|
:'cache_id' => :'cache_id',
|
|
264
288
|
:'document_url' => :'document_url',
|
|
265
289
|
:'document_base64' => :'document_base64',
|
|
@@ -295,6 +319,7 @@ module DocSpring
|
|
|
295
319
|
:'ai_field_naming_language' => :'AiFieldNamingLanguage',
|
|
296
320
|
:'allow_additional_properties' => :'Boolean',
|
|
297
321
|
:'allow_skipping_optional_fields' => :'Boolean',
|
|
322
|
+
:'continue_before_optional_fields' => :'Boolean',
|
|
298
323
|
:'default_form_mode' => :'TemplateFormMode',
|
|
299
324
|
:'editable_submissions' => :'Boolean',
|
|
300
325
|
:'embed_domains' => :'Array<String>',
|
|
@@ -321,9 +346,12 @@ module DocSpring
|
|
|
321
346
|
:'success_title' => :'String',
|
|
322
347
|
:'success_message' => :'String',
|
|
323
348
|
:'show_fill_again_button' => :'Boolean',
|
|
349
|
+
:'form_sections_in_order' => :'Boolean',
|
|
324
350
|
:'slack_webhook_url' => :'String',
|
|
325
351
|
:'defaults' => :'TemplateDefaultsInput',
|
|
326
352
|
:'field_dependencies' => :'Array<TemplateFieldDependencyInput>',
|
|
353
|
+
:'signer_roles' => :'Array<TemplateSignerRoleInput>',
|
|
354
|
+
:'signature_request_cc' => :'Array<String>',
|
|
327
355
|
:'predefined_fields' => :'Array<PredefinedFieldInput>',
|
|
328
356
|
:'predefined_fields_sample_data' => :'Hash<String, Object>',
|
|
329
357
|
:'html' => :'String',
|
|
@@ -333,6 +361,8 @@ module DocSpring
|
|
|
333
361
|
:'html_engine_options' => :'HtmlEngineOptionsInput',
|
|
334
362
|
:'html_escape_data' => :'Boolean',
|
|
335
363
|
:'layout' => :'Hash<String, Object>',
|
|
364
|
+
:'override_account_expiry' => :'Boolean',
|
|
365
|
+
:'sync_fields' => :'Boolean',
|
|
336
366
|
:'cache_id' => :'String',
|
|
337
367
|
:'document_url' => :'String',
|
|
338
368
|
:'document_base64' => :'String',
|
|
@@ -438,6 +468,10 @@ module DocSpring
|
|
|
438
468
|
self.allow_skipping_optional_fields = attributes[:'allow_skipping_optional_fields']
|
|
439
469
|
end
|
|
440
470
|
|
|
471
|
+
if attributes.key?(:'continue_before_optional_fields')
|
|
472
|
+
self.continue_before_optional_fields = attributes[:'continue_before_optional_fields']
|
|
473
|
+
end
|
|
474
|
+
|
|
441
475
|
if attributes.key?(:'default_form_mode')
|
|
442
476
|
self.default_form_mode = attributes[:'default_form_mode']
|
|
443
477
|
end
|
|
@@ -546,6 +580,10 @@ module DocSpring
|
|
|
546
580
|
self.show_fill_again_button = attributes[:'show_fill_again_button']
|
|
547
581
|
end
|
|
548
582
|
|
|
583
|
+
if attributes.key?(:'form_sections_in_order')
|
|
584
|
+
self.form_sections_in_order = attributes[:'form_sections_in_order']
|
|
585
|
+
end
|
|
586
|
+
|
|
549
587
|
if attributes.key?(:'slack_webhook_url')
|
|
550
588
|
self.slack_webhook_url = attributes[:'slack_webhook_url']
|
|
551
589
|
end
|
|
@@ -560,6 +598,18 @@ module DocSpring
|
|
|
560
598
|
end
|
|
561
599
|
end
|
|
562
600
|
|
|
601
|
+
if attributes.key?(:'signer_roles')
|
|
602
|
+
if (value = attributes[:'signer_roles']).is_a?(Array)
|
|
603
|
+
self.signer_roles = value
|
|
604
|
+
end
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
if attributes.key?(:'signature_request_cc')
|
|
608
|
+
if (value = attributes[:'signature_request_cc']).is_a?(Array)
|
|
609
|
+
self.signature_request_cc = value
|
|
610
|
+
end
|
|
611
|
+
end
|
|
612
|
+
|
|
563
613
|
if attributes.key?(:'predefined_fields')
|
|
564
614
|
if (value = attributes[:'predefined_fields']).is_a?(Array)
|
|
565
615
|
self.predefined_fields = value
|
|
@@ -602,6 +652,14 @@ module DocSpring
|
|
|
602
652
|
end
|
|
603
653
|
end
|
|
604
654
|
|
|
655
|
+
if attributes.key?(:'override_account_expiry')
|
|
656
|
+
self.override_account_expiry = attributes[:'override_account_expiry']
|
|
657
|
+
end
|
|
658
|
+
|
|
659
|
+
if attributes.key?(:'sync_fields')
|
|
660
|
+
self.sync_fields = attributes[:'sync_fields']
|
|
661
|
+
end
|
|
662
|
+
|
|
605
663
|
if attributes.key?(:'cache_id')
|
|
606
664
|
self.cache_id = attributes[:'cache_id']
|
|
607
665
|
end
|
|
@@ -694,6 +752,7 @@ module DocSpring
|
|
|
694
752
|
ai_field_naming_language == o.ai_field_naming_language &&
|
|
695
753
|
allow_additional_properties == o.allow_additional_properties &&
|
|
696
754
|
allow_skipping_optional_fields == o.allow_skipping_optional_fields &&
|
|
755
|
+
continue_before_optional_fields == o.continue_before_optional_fields &&
|
|
697
756
|
default_form_mode == o.default_form_mode &&
|
|
698
757
|
editable_submissions == o.editable_submissions &&
|
|
699
758
|
embed_domains == o.embed_domains &&
|
|
@@ -720,9 +779,12 @@ module DocSpring
|
|
|
720
779
|
success_title == o.success_title &&
|
|
721
780
|
success_message == o.success_message &&
|
|
722
781
|
show_fill_again_button == o.show_fill_again_button &&
|
|
782
|
+
form_sections_in_order == o.form_sections_in_order &&
|
|
723
783
|
slack_webhook_url == o.slack_webhook_url &&
|
|
724
784
|
defaults == o.defaults &&
|
|
725
785
|
field_dependencies == o.field_dependencies &&
|
|
786
|
+
signer_roles == o.signer_roles &&
|
|
787
|
+
signature_request_cc == o.signature_request_cc &&
|
|
726
788
|
predefined_fields == o.predefined_fields &&
|
|
727
789
|
predefined_fields_sample_data == o.predefined_fields_sample_data &&
|
|
728
790
|
html == o.html &&
|
|
@@ -732,6 +794,8 @@ module DocSpring
|
|
|
732
794
|
html_engine_options == o.html_engine_options &&
|
|
733
795
|
html_escape_data == o.html_escape_data &&
|
|
734
796
|
layout == o.layout &&
|
|
797
|
+
override_account_expiry == o.override_account_expiry &&
|
|
798
|
+
sync_fields == o.sync_fields &&
|
|
735
799
|
cache_id == o.cache_id &&
|
|
736
800
|
document_url == o.document_url &&
|
|
737
801
|
document_base64 == o.document_base64 &&
|
|
@@ -752,7 +816,7 @@ module DocSpring
|
|
|
752
816
|
# Calculates hash code according to all attributes.
|
|
753
817
|
# @return [Integer] Hash code
|
|
754
818
|
def hash
|
|
755
|
-
[name, description, template_type, output_format, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, success_title, success_message, show_fill_again_button, slack_webhook_url, defaults, field_dependencies, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, cache_id, document_url, document_base64, filename, detect_fields, field_source, field_naming, field_logic, include_office_use_fields].hash
|
|
819
|
+
[name, description, template_type, output_format, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, continue_before_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, success_title, success_message, show_fill_again_button, form_sections_in_order, slack_webhook_url, defaults, field_dependencies, signer_roles, signature_request_cc, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, override_account_expiry, sync_fields, cache_id, document_url, document_base64, filename, detect_fields, field_source, field_naming, field_logic, include_office_use_fields].hash
|
|
756
820
|
end
|
|
757
821
|
|
|
758
822
|
# Builds the object from hash
|
|
@@ -64,7 +64,7 @@ module DocSpring
|
|
|
64
64
|
# Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
|
|
65
65
|
attr_accessor :file_formats
|
|
66
66
|
|
|
67
|
-
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
|
|
67
|
+
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days, or until the submission expires if that's sooner. Accounts with a BAA start with `link`.
|
|
68
68
|
attr_accessor :delivery
|
|
69
69
|
|
|
70
70
|
# With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
|
|
@@ -16,7 +16,7 @@ require 'time'
|
|
|
16
16
|
module DocSpring
|
|
17
17
|
# What went wrong.
|
|
18
18
|
class ErrorInfo < ApiModelBase
|
|
19
|
-
# A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept, or it failed after creating or changing a record, and the message says which. When the first request created a record, or changed a template's fields or published a version of it, the message names it, and its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id`, `webhook_id`, `email_action_id` or `email_domain_id` (a signature request's events and tokens have no member). `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`).
|
|
19
|
+
# A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions, or it's scheduled for deletion, so every request is refused until one of its users signs in to cancel that. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept, or it failed after creating or changing a record, and the message says which. When the first request created a record, or changed a template's fields or published a version of it, the message names it, and its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id`, `webhook_id`, `email_action_id` or `email_domain_id` (a signature request's events and tokens have no member). `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`).
|
|
20
20
|
attr_accessor :code
|
|
21
21
|
|
|
22
22
|
# A human-readable explanation, safe to show to developers.
|