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
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldDependencyConditionInput
|
|
2
|
-
|
|
3
|
-
## Class instance methods
|
|
4
|
-
|
|
5
|
-
### `openapi_one_of`
|
|
6
|
-
|
|
7
|
-
Returns the list of classes defined in oneOf.
|
|
8
|
-
|
|
9
|
-
#### Example
|
|
10
|
-
|
|
11
|
-
```ruby
|
|
12
|
-
require 'docspring'
|
|
13
|
-
|
|
14
|
-
DocSpring::TemplateFieldDependencyConditionInput.openapi_one_of
|
|
15
|
-
# =>
|
|
16
|
-
# [
|
|
17
|
-
# :'FieldComparisonCondition',
|
|
18
|
-
# :'FieldEqualsCondition',
|
|
19
|
-
# :'FieldInCondition',
|
|
20
|
-
# :'FieldPresenceCondition',
|
|
21
|
-
# :'FieldRangeCondition'
|
|
22
|
-
# ]
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### `openapi_discriminator_name`
|
|
26
|
-
|
|
27
|
-
Returns the discriminator's property name.
|
|
28
|
-
|
|
29
|
-
#### Example
|
|
30
|
-
|
|
31
|
-
```ruby
|
|
32
|
-
require 'docspring'
|
|
33
|
-
|
|
34
|
-
DocSpring::TemplateFieldDependencyConditionInput.openapi_discriminator_name
|
|
35
|
-
# => :'operator'
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### `openapi_discriminator_name`
|
|
39
|
-
|
|
40
|
-
Returns the discriminator's mapping.
|
|
41
|
-
|
|
42
|
-
#### Example
|
|
43
|
-
|
|
44
|
-
```ruby
|
|
45
|
-
require 'docspring'
|
|
46
|
-
|
|
47
|
-
DocSpring::TemplateFieldDependencyConditionInput.openapi_discriminator_mapping
|
|
48
|
-
# =>
|
|
49
|
-
# {
|
|
50
|
-
# :'blank' => :'FieldPresenceCondition',
|
|
51
|
-
# :'equals' => :'FieldEqualsCondition',
|
|
52
|
-
# :'gt' => :'FieldComparisonCondition',
|
|
53
|
-
# :'gte' => :'FieldComparisonCondition',
|
|
54
|
-
# :'in' => :'FieldInCondition',
|
|
55
|
-
# :'lt' => :'FieldComparisonCondition',
|
|
56
|
-
# :'lte' => :'FieldComparisonCondition',
|
|
57
|
-
# :'not_equals' => :'FieldEqualsCondition',
|
|
58
|
-
# :'present' => :'FieldPresenceCondition',
|
|
59
|
-
# :'range' => :'FieldRangeCondition'
|
|
60
|
-
# }
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
### build
|
|
64
|
-
|
|
65
|
-
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
66
|
-
|
|
67
|
-
#### Example
|
|
68
|
-
|
|
69
|
-
```ruby
|
|
70
|
-
require 'docspring'
|
|
71
|
-
|
|
72
|
-
DocSpring::TemplateFieldDependencyConditionInput.build(data)
|
|
73
|
-
# => #<FieldComparisonCondition:0x00007fdd4aab02a0>
|
|
74
|
-
|
|
75
|
-
DocSpring::TemplateFieldDependencyConditionInput.build(data_that_doesnt_match)
|
|
76
|
-
# => nil
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
#### Parameters
|
|
80
|
-
|
|
81
|
-
| Name | Type | Description |
|
|
82
|
-
| ---- | ---- | ----------- |
|
|
83
|
-
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
84
|
-
|
|
85
|
-
#### Return type
|
|
86
|
-
|
|
87
|
-
- `FieldComparisonCondition`
|
|
88
|
-
- `FieldEqualsCondition`
|
|
89
|
-
- `FieldInCondition`
|
|
90
|
-
- `FieldPresenceCondition`
|
|
91
|
-
- `FieldRangeCondition`
|
|
92
|
-
- `nil` (if no type matches)
|
|
93
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldDependencyInput
|
|
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<TemplateFieldDependencyConditionInput>**](TemplateFieldDependencyConditionInput.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::TemplateFieldDependencyInput.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::TemplateFieldDependencyMatch
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplateFieldDependencyMatch.new()
|
|
14
|
-
```
|
|
15
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldDependencyOperator
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplateFieldDependencyOperator.new()
|
|
14
|
-
```
|
|
15
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldLogicStatus
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplateFieldLogicStatus.new()
|
|
14
|
-
```
|
|
15
|
-
|
data/docs/TemplateFieldMove.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFieldMove
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **Integer** | The field's ID. | |
|
|
8
|
-
| **old_index** | **Integer** | Its place in `from_version`'s field order, starting at 0. | |
|
|
9
|
-
| **new_index** | **Integer** | Its place in `to_version`'s field order, starting at 0. | |
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```ruby
|
|
14
|
-
require 'docspring'
|
|
15
|
-
|
|
16
|
-
instance = DocSpring::TemplateFieldMove.new(
|
|
17
|
-
id: null,
|
|
18
|
-
old_index: null,
|
|
19
|
-
new_index: null
|
|
20
|
-
)
|
|
21
|
-
```
|
|
22
|
-
|
data/docs/TemplateFields.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFields
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **template_id** | **String** | The template's ID. | |
|
|
8
|
-
| **version** | **String** | The published version the fields are of, such as `1.2.0`. Null for the draft. | |
|
|
9
|
-
| **fields** | [**Array<Field>**](Field.md) | The fields. | |
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```ruby
|
|
14
|
-
require 'docspring'
|
|
15
|
-
|
|
16
|
-
instance = DocSpring::TemplateFields.new(
|
|
17
|
-
template_id: null,
|
|
18
|
-
version: null,
|
|
19
|
-
fields: null
|
|
20
|
-
)
|
|
21
|
-
```
|
|
22
|
-
|
data/docs/TemplateFormMode.md
DELETED
data/docs/TemplateFormSection.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFormSection
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | The section's ID, unique among the template's sections. Any string you choose. | |
|
|
8
|
-
| **title** | **String** | The section's heading on the web form. | |
|
|
9
|
-
| **description** | **String** | Text shown under the section's heading. Null for none. | |
|
|
10
|
-
| **field_ids** | **Array<Integer>** | The IDs of the section's fields (Field's `id`), in the order the web form shows them. A field can be in one section only. | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateFormSection.new(
|
|
18
|
-
id: null,
|
|
19
|
-
title: null,
|
|
20
|
-
description: null,
|
|
21
|
-
field_ids: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateFormSectionInput
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | The section's ID, unique among the template's sections. Any string you choose. | |
|
|
8
|
-
| **title** | **String** | The section's heading on the web form. | |
|
|
9
|
-
| **description** | **String** | Text shown under the section's heading. Null for none. | [optional] |
|
|
10
|
-
| **field_ids** | **Array<Integer>** | The IDs of the section's fields (Field's `id`), in the order the web form shows them. A field can be in one section only. | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateFormSectionInput.new(
|
|
18
|
-
id: null,
|
|
19
|
-
title: null,
|
|
20
|
-
description: null,
|
|
21
|
-
field_ids: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
data/docs/TemplateModelCode.md
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateModelCode
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **lang** | [**ModelCodeLanguage**](ModelCodeLanguage.md) | The language of `code`. | |
|
|
8
|
-
| **root_type_name** | **String** | The name of the type for the whole submission data object. | |
|
|
9
|
-
| **code** | **String** | The source code of the types, starting with `root_type_name`. | |
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```ruby
|
|
14
|
-
require 'docspring'
|
|
15
|
-
|
|
16
|
-
instance = DocSpring::TemplateModelCode.new(
|
|
17
|
-
lang: null,
|
|
18
|
-
root_type_name: null,
|
|
19
|
-
code: null
|
|
20
|
-
)
|
|
21
|
-
```
|
|
22
|
-
|
data/docs/TemplatePageAiError.md
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplatePageAiNamingStatus
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplatePageAiNamingStatus.new()
|
|
14
|
-
```
|
|
15
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplatePageFieldsStatus
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplatePageFieldsStatus.new()
|
|
14
|
-
```
|
|
15
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplatePageImageStatus
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TemplatePageImageStatus.new()
|
|
14
|
-
```
|
|
15
|
-
|
data/docs/TemplatePageImages.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplatePageImages
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **template_id** | **String** | The template's ID. | |
|
|
8
|
-
| **version** | **String** | The published version the images are of, such as `1.2.0`. Null for the draft. | |
|
|
9
|
-
| **page_count** | **Integer** | How many pages the PDF has. | |
|
|
10
|
-
| **pages** | [**Array<PageImage>**](PageImage.md) | An image of each page, in order: `pages[0]` is page 1. Their `download_url`s expire, so get them again when you need them. | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplatePageImages.new(
|
|
18
|
-
template_id: null,
|
|
19
|
-
version: null,
|
|
20
|
-
page_count: null,
|
|
21
|
-
pages: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplatePageProcessingStatus
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **image** | [**TemplatePageImageStatus**](TemplatePageImageStatus.md) | The page's image, which the template editor shows. `pending` until it's rendered. | |
|
|
8
|
-
| **fields** | [**TemplatePageFieldsStatus**](TemplatePageFieldsStatus.md) | Setting up the page's fields: `pending` while they're imported or detected, `naming` while AI names them, then `processed` or `failed`. `disabled` when DocSpring doesn't set up the page's fields. | |
|
|
9
|
-
| **ai_naming** | [**TemplatePageAiNamingStatus**](TemplatePageAiNamingStatus.md) | `failed` or `skipped` when AI didn't name the page's fields as asked (`ai_error` says why), and the fields kept plain names. Null otherwise. | |
|
|
10
|
-
| **ai_error** | [**TemplatePageAiError**](TemplatePageAiError.md) | Why AI naming failed or was skipped: `unavailable` (the AI service was unavailable: set up the fields again later), `error`, `credits` (the account had no free AI pages or credits left) or `skipped` (someone skipped AI setup in the template editor). Null when `ai_naming` is. | |
|
|
11
|
-
| **detected_boxes** | **Array<Array<Float>>** | While AI names the page's fields, the boxes field detection found: `[x, y, width, height]` in PDF points from the page's top-left corner. Null otherwise. | |
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```ruby
|
|
16
|
-
require 'docspring'
|
|
17
|
-
|
|
18
|
-
instance = DocSpring::TemplatePageProcessingStatus.new(
|
|
19
|
-
image: null,
|
|
20
|
-
fields: null,
|
|
21
|
-
ai_naming: null,
|
|
22
|
-
ai_error: null,
|
|
23
|
-
detected_boxes: null
|
|
24
|
-
)
|
|
25
|
-
```
|
|
26
|
-
|
data/docs/TemplatePreview.md
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplatePreview
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** | The preview's ID. | |
|
|
8
|
-
| **template_id** | **String** | The template's ID. | |
|
|
9
|
-
| **version** | **String** | The published version that was rendered, such as `1.2.0`. Null for the draft. | |
|
|
10
|
-
| **state** | [**TemplatePreviewState**](TemplatePreviewState.md) | `pending` while it renders (usually a few seconds), then `processed`, or `error` with an `error_message`. | |
|
|
11
|
-
| **error_message** | **String** | Why the preview couldn't be rendered, such as an error in an HTML or Word template's Liquid, or a value in the data that a field can't print. | |
|
|
12
|
-
| **page_count** | **Integer** | How many pages the template printed, once it's processed. | |
|
|
13
|
-
| **pages** | [**Array<PageImage>**](PageImage.md) | A PNG image of each page once it's processed, in order: `pages[0]` is page 1. A preview has no PDF. Their `download_url`s expire, so get the preview again when you need them. | |
|
|
14
|
-
| **expires_at** | **Time** | When the preview and its images are deleted. | |
|
|
15
|
-
|
|
16
|
-
## Example
|
|
17
|
-
|
|
18
|
-
```ruby
|
|
19
|
-
require 'docspring'
|
|
20
|
-
|
|
21
|
-
instance = DocSpring::TemplatePreview.new(
|
|
22
|
-
id: null,
|
|
23
|
-
template_id: null,
|
|
24
|
-
version: null,
|
|
25
|
-
state: null,
|
|
26
|
-
error_message: null,
|
|
27
|
-
page_count: null,
|
|
28
|
-
pages: null,
|
|
29
|
-
expires_at: null
|
|
30
|
-
)
|
|
31
|
-
```
|
|
32
|
-
|
data/docs/TemplateSourcePdf.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateSourcePdf
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **type** | **String** | Must be `template`. | [default to 'template'] |
|
|
8
|
-
| **id** | **String** | The ID of the submission, combined PDF, template or custom file. | |
|
|
9
|
-
| **template_version** | **String** | For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`. | [optional] |
|
|
10
|
-
| **processed** | **Boolean** | For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded. | [optional] |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateSourcePdf.new(
|
|
18
|
-
type: null,
|
|
19
|
-
id: null,
|
|
20
|
-
template_version: null,
|
|
21
|
-
processed: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
data/docs/TemplateSummary.md
DELETED
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateSummary
|
|
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** | [**TemplateDocumentSummary**](TemplateDocumentSummary.md) | The PDF of a PDF template, or the Word document of a Word template: its file name, page count and processing state. Null for HTML templates and page designs, and for a PDF template that has no PDF yet. A template created from a `document_url`, or a Word template created from an OpenDocument file (.odt), has one, with no file, while it's downloaded or converted. | |
|
|
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
|
-
|
|
23
|
-
## Example
|
|
24
|
-
|
|
25
|
-
```ruby
|
|
26
|
-
require 'docspring'
|
|
27
|
-
|
|
28
|
-
instance = DocSpring::TemplateSummary.new(
|
|
29
|
-
id: null,
|
|
30
|
-
name: null,
|
|
31
|
-
description: null,
|
|
32
|
-
template_type: null,
|
|
33
|
-
output_format: null,
|
|
34
|
-
ready: null,
|
|
35
|
-
document: null,
|
|
36
|
-
parent_folder_id: null,
|
|
37
|
-
path: null,
|
|
38
|
-
latest_version: null,
|
|
39
|
-
version_published_at: null,
|
|
40
|
-
locked: null,
|
|
41
|
-
last_changed_at: null,
|
|
42
|
-
created_at: null,
|
|
43
|
-
updated_at: null
|
|
44
|
-
)
|
|
45
|
-
```
|
|
46
|
-
|
data/docs/TemplateSummaryList.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateSummaryList
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **data** | [**Array<TemplateSummary>**](TemplateSummary.md) | The items on this page. | |
|
|
8
|
-
| **next_cursor** | **String** | Pass it as `cursor` to get the next page. Null on the last page. | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'docspring'
|
|
14
|
-
|
|
15
|
-
instance = DocSpring::TemplateSummaryList.new(
|
|
16
|
-
data: null,
|
|
17
|
-
next_cursor: null
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
data/docs/TemplateType.md
DELETED
data/docs/TemplateVersion.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# DocSpring::TemplateVersion
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **version** | **String** | The version number, such as `1.2.0`. | |
|
|
8
|
-
| **description** | **String** | What changed in the version, as written when it was published. | |
|
|
9
|
-
| **published_at** | **Time** | When the version was published. | |
|
|
10
|
-
| **published_by** | [**TemplateActor**](TemplateActor.md) | Who published the version. Null when that wasn't recorded. | |
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```ruby
|
|
15
|
-
require 'docspring'
|
|
16
|
-
|
|
17
|
-
instance = DocSpring::TemplateVersion.new(
|
|
18
|
-
version: null,
|
|
19
|
-
description: null,
|
|
20
|
-
published_at: null,
|
|
21
|
-
published_by: null
|
|
22
|
-
)
|
|
23
|
-
```
|
|
24
|
-
|
data/docs/TemplateVersionType.md
DELETED
data/docs/TextAlignment.md
DELETED
data/docs/TextOverflow.md
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# DocSpring::TextVerticalAlignment
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
|
|
8
|
-
## Example
|
|
9
|
-
|
|
10
|
-
```ruby
|
|
11
|
-
require 'docspring'
|
|
12
|
-
|
|
13
|
-
instance = DocSpring::TextVerticalAlignment.new()
|
|
14
|
-
```
|
|
15
|
-
|