docspring 3.5.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.openapi-generator/FILES +361 -150
- data/.openapi-generator/VERSION +1 -1
- data/.rubocop.yml +1 -1
- data/.travis.yml +1 -1
- data/AGENTS.md +79 -19
- data/CHANGELOG.md +123 -0
- data/Gemfile.lock +7 -7
- data/README.md +60 -53
- data/docs/{RenameFolderData.md → AiFieldNamingLanguage.md} +2 -5
- data/docs/AuthenticationCheck.md +18 -0
- data/docs/{CreateFolderData.md → BarcodeSymbology.md} +2 -5
- data/docs/{CreateWebhookData.md → CheckCharacter.md} +2 -5
- data/docs/Client.md +890 -777
- data/docs/{UpdateWebhookData.md → CombinedFieldType.md} +2 -5
- data/docs/CombinedPdf.md +44 -0
- data/docs/CombinedPdfFiles.md +18 -0
- data/docs/CombinedPdfList.md +20 -0
- data/docs/CombinedPdfSource.md +26 -0
- data/docs/CombinedPdfSourceInput.md +88 -0
- data/docs/CombinedPdfSourcePdf.md +20 -0
- data/docs/CombinedPdfSourceType.md +15 -0
- data/docs/CombinedPdfState.md +15 -0
- data/docs/CopyTemplateRequest.md +22 -0
- data/docs/CreateCombinedPdfRequest.md +26 -0
- data/docs/CreateCustomFileFromUploadRequest.md +18 -0
- data/docs/CreateFolderRequest.md +20 -0
- data/docs/CreateSignatureRequestEventRequest.md +24 -0
- data/docs/CreateSignatureRequestTokenRequest.md +18 -0
- data/docs/CreateSubmissionBatchRequest.md +26 -0
- data/docs/CreateSubmissionRequest.md +36 -0
- data/docs/CreateTemplateRequest.md +94 -0
- data/docs/CreateWebhookRequest.md +38 -0
- data/docs/CustomFile.md +11 -3
- data/docs/CustomFileList.md +20 -0
- data/docs/CustomFileSourcePdf.md +20 -0
- data/docs/ErrorCode.md +15 -0
- data/docs/ErrorDetail.md +26 -0
- data/docs/ErrorInfo.md +32 -0
- data/docs/ErrorResponse.md +1 -3
- data/docs/ExpirationInterval.md +15 -0
- data/docs/FieldComparisonCondition.md +22 -0
- data/docs/FieldComparisonOperator.md +15 -0
- data/docs/FieldDisplayType.md +15 -0
- data/docs/FieldEqualsCondition.md +22 -0
- data/docs/FieldEqualsOperator.md +15 -0
- data/docs/FieldInCondition.md +22 -0
- data/docs/FieldOverride.md +142 -0
- data/docs/FieldPresenceCondition.md +20 -0
- data/docs/FieldPresenceOperator.md +15 -0
- data/docs/FieldRangeCondition.md +24 -0
- data/docs/FieldReimportState.md +15 -0
- data/docs/FieldSetupLogic.md +15 -0
- data/docs/FieldSetupNaming.md +15 -0
- data/docs/FieldSetupSource.md +15 -0
- data/docs/Folder.md +9 -5
- data/docs/FolderList.md +20 -0
- data/docs/GeneratedFile.md +32 -0
- data/docs/GeneratedFileState.md +15 -0
- data/docs/HtmlEngineOptions.md +36 -0
- data/docs/HtmlEngineOptionsInput.md +36 -0
- data/docs/ImageGravity.md +15 -0
- data/docs/ImageScaleType.md +15 -0
- data/docs/ModelCodeLanguage.md +15 -0
- data/docs/MoveFolderRequest.md +18 -0
- data/docs/MoveTemplateRequest.md +18 -0
- data/docs/NumberConditionType.md +15 -0
- data/docs/PageFormat.md +15 -0
- data/docs/PublishTemplateVersionRequest.md +20 -0
- data/docs/RenameFolderRequest.md +18 -0
- data/docs/RestoreTemplateVersionRequest.md +18 -0
- data/docs/ShapeType.md +15 -0
- data/docs/SignatureRequest.md +66 -0
- data/docs/SignatureRequestAuthSecondFactorType.md +15 -0
- data/docs/SignatureRequestAuthType.md +15 -0
- data/docs/SignatureRequestEvent.md +32 -0
- data/docs/SignatureRequestEventType.md +15 -0
- data/docs/SignatureRequestInput.md +46 -0
- data/docs/SignatureRequestMessageType.md +15 -0
- data/docs/SignatureRequestState.md +15 -0
- data/docs/SignatureRequestToken.md +30 -0
- data/docs/SignatureRequestTokenType.md +15 -0
- data/docs/StringConditionType.md +15 -0
- data/docs/Submission.md +41 -47
- data/docs/SubmissionAction.md +6 -8
- data/docs/SubmissionActionState.md +15 -0
- data/docs/SubmissionActionType.md +15 -0
- data/docs/SubmissionBatch.md +16 -10
- data/docs/SubmissionBatchState.md +15 -0
- data/docs/SubmissionFiles.md +22 -0
- data/docs/SubmissionInput.md +38 -0
- data/docs/SubmissionList.md +20 -0
- data/docs/SubmissionSource.md +15 -0
- data/docs/SubmissionSourcePdf.md +20 -0
- data/docs/SubmissionState.md +15 -0
- data/docs/Template.md +73 -107
- data/docs/TemplateActor.md +26 -0
- data/docs/TemplateActorType.md +15 -0
- data/docs/TemplateDefaults.md +56 -0
- data/docs/TemplateDefaultsInput.md +56 -0
- data/docs/TemplateDocument.md +40 -0
- data/docs/TemplateDocumentState.md +15 -0
- data/docs/TemplateFieldDependency.md +26 -0
- data/docs/TemplateFieldDependencyAction.md +15 -0
- data/docs/TemplateFieldDependencyCondition.md +24 -0
- data/docs/TemplateFieldDependencyConditionInput.md +93 -0
- data/docs/TemplateFieldDependencyInput.md +26 -0
- data/docs/TemplateFieldDependencyMatch.md +15 -0
- data/docs/TemplateFieldDependencyOperator.md +15 -0
- data/docs/TemplateFieldLogicStatus.md +15 -0
- data/docs/TemplateFormMode.md +15 -0
- data/docs/TemplateModelCode.md +22 -0
- data/docs/TemplatePageAiError.md +15 -0
- data/docs/TemplatePageAiNamingStatus.md +15 -0
- data/docs/TemplatePageFieldsStatus.md +15 -0
- data/docs/TemplatePageImageStatus.md +15 -0
- data/docs/TemplatePageProcessingStatus.md +26 -0
- data/docs/TemplateSourcePdf.md +24 -0
- data/docs/TemplateSummary.md +90 -0
- data/docs/TemplateSummaryList.md +20 -0
- data/docs/TemplateType.md +15 -0
- data/docs/TemplateVersion.md +24 -0
- data/docs/TemplateVersionType.md +15 -0
- data/docs/TextAlignment.md +15 -0
- data/docs/TextOverflow.md +15 -0
- data/docs/TextVerticalAlignment.md +15 -0
- data/docs/Typeface.md +15 -0
- data/docs/UpdateSignatureRequestRequest.md +34 -0
- data/docs/UpdateTemplateDocumentRequest.md +22 -0
- data/docs/UpdateTemplateRequest.md +80 -0
- data/docs/UpdateWebhookRequest.md +38 -0
- data/docs/UploadMethod.md +15 -0
- data/docs/UploadPresign.md +24 -0
- data/docs/UrlSourcePdf.md +20 -0
- data/docs/Webhook.md +20 -20
- data/docs/WebhookEventType.md +15 -0
- data/docs/WebhookList.md +20 -0
- data/docs/WebhookMode.md +15 -0
- data/docspring.gemspec +3 -3
- data/lib/docspring/api/client.rb +995 -942
- data/lib/docspring/api_client.rb +14 -6
- data/lib/docspring/api_error.rb +3 -3
- data/lib/docspring/api_model_base.rb +88 -0
- data/lib/docspring/configuration.rb +12 -7
- data/lib/docspring/models/ai_field_naming_language.rb +42 -0
- data/lib/docspring/models/authentication_check.rb +185 -0
- data/lib/docspring/models/barcode_symbology.rb +47 -0
- data/lib/docspring/models/check_character.rb +44 -0
- data/lib/docspring/models/combined_field_type.rb +41 -0
- data/lib/docspring/models/{combined_submission.rb → combined_pdf.rb} +228 -206
- data/lib/docspring/models/combined_pdf_files.rb +167 -0
- data/lib/docspring/models/combined_pdf_list.rb +200 -0
- data/lib/docspring/models/{update_webhook_data.rb → combined_pdf_source.rb} +107 -103
- data/lib/docspring/models/combined_pdf_source_input.rb +62 -0
- data/lib/docspring/models/combined_pdf_source_pdf.rb +212 -0
- data/lib/docspring/models/combined_pdf_source_type.rb +44 -0
- data/lib/docspring/models/combined_pdf_state.rb +44 -0
- data/lib/docspring/models/{copy_template_options.rb → copy_template_request.rb} +32 -87
- data/lib/docspring/models/{combine_pdfs_data.rb → create_combined_pdf_request.rb} +60 -123
- data/lib/docspring/models/{create_custom_file_data.rb → create_custom_file_from_upload_request.rb} +29 -96
- data/lib/docspring/models/{move_template_data.rb → create_folder_request.rb} +60 -102
- data/lib/docspring/models/{create_submission_data_request_event_request.rb → create_signature_request_event_request.rb} +50 -122
- data/lib/docspring/models/create_signature_request_token_request.rb +190 -0
- data/lib/docspring/models/{submission_batch_data.rb → create_submission_batch_request.rb} +53 -108
- data/lib/docspring/models/{create_pdf_submission_data.rb → create_submission_request.rb} +97 -149
- data/lib/docspring/models/create_template_request.rb +601 -0
- data/lib/docspring/models/create_webhook_request.rb +368 -0
- data/lib/docspring/models/custom_file.rb +132 -95
- data/lib/docspring/models/custom_file_list.rb +200 -0
- data/lib/docspring/models/custom_file_source_pdf.rb +212 -0
- data/lib/docspring/models/error_code.rb +60 -0
- data/lib/docspring/models/error_detail.rb +242 -0
- data/lib/docspring/models/error_info.rb +316 -0
- data/lib/docspring/models/error_response.rb +28 -138
- data/lib/docspring/models/expiration_interval.rb +42 -0
- data/lib/docspring/models/field_comparison_condition.rb +247 -0
- data/lib/docspring/models/field_comparison_operator.rb +43 -0
- data/lib/docspring/models/field_display_type.rb +45 -0
- data/lib/docspring/models/field_equals_condition.rb +247 -0
- data/lib/docspring/models/field_equals_operator.rb +41 -0
- data/lib/docspring/models/{create_folder_data.rb → field_in_condition.rb} +101 -103
- data/lib/docspring/models/field_override.rb +829 -0
- data/lib/docspring/models/field_presence_condition.rb +234 -0
- data/lib/docspring/models/field_presence_operator.rb +41 -0
- data/lib/docspring/models/field_range_condition.rb +234 -0
- data/lib/docspring/models/field_reimport_state.rb +43 -0
- data/lib/docspring/models/field_setup_logic.rb +41 -0
- data/lib/docspring/models/field_setup_naming.rb +41 -0
- data/lib/docspring/models/field_setup_source.rb +42 -0
- data/lib/docspring/models/folder.rb +134 -93
- data/lib/docspring/models/folder_list.rb +200 -0
- data/lib/docspring/models/generated_file.rb +326 -0
- data/lib/docspring/models/generated_file_state.rb +42 -0
- data/lib/docspring/models/html_engine_options.rb +416 -0
- data/lib/docspring/models/html_engine_options_input.rb +280 -0
- data/lib/docspring/models/image_gravity.rb +48 -0
- data/lib/docspring/models/image_scale_type.rb +42 -0
- data/lib/docspring/models/model_code_language.rb +48 -0
- data/lib/docspring/models/{move_folder_data.rb → move_folder_request.rb} +31 -87
- data/lib/docspring/models/move_template_request.rb +171 -0
- data/lib/docspring/models/number_condition_type.rb +45 -0
- data/lib/docspring/models/page_format.rb +52 -0
- data/lib/docspring/models/{publish_version_data.rb → publish_template_version_request.rb} +64 -99
- data/lib/docspring/models/{rename_folder_data.rb → rename_folder_request.rb} +29 -87
- data/lib/docspring/models/{restore_version_data.rb → restore_template_version_request.rb} +29 -87
- data/lib/docspring/models/shape_type.rb +45 -0
- data/lib/docspring/models/{submission_data_request_show.rb → signature_request.rb} +240 -171
- data/lib/docspring/models/signature_request_auth_second_factor_type.rb +45 -0
- data/lib/docspring/models/signature_request_auth_type.rb +46 -0
- data/lib/docspring/models/{submission_data_request_event.rb → signature_request_event.rb} +137 -122
- data/lib/docspring/models/signature_request_event_type.rb +45 -0
- data/lib/docspring/models/{update_submission_data_request_data.rb → signature_request_input.rb} +156 -173
- data/lib/docspring/models/signature_request_message_type.rb +48 -0
- data/lib/docspring/models/signature_request_state.rb +42 -0
- data/lib/docspring/models/signature_request_token.rb +369 -0
- data/lib/docspring/models/signature_request_token_type.rb +41 -0
- data/lib/docspring/models/string_condition_type.rb +44 -0
- data/lib/docspring/models/submission.rb +374 -339
- data/lib/docspring/models/submission_action.rb +64 -136
- data/lib/docspring/models/submission_action_state.rb +43 -0
- data/lib/docspring/models/submission_action_type.rb +46 -0
- data/lib/docspring/models/submission_batch.rb +157 -112
- data/lib/docspring/models/submission_batch_state.rb +42 -0
- data/lib/docspring/models/submission_files.rb +188 -0
- data/lib/docspring/models/submission_input.rb +274 -0
- data/lib/docspring/models/submission_list.rb +200 -0
- data/lib/docspring/models/submission_source.rb +43 -0
- data/lib/docspring/models/submission_source_pdf.rb +212 -0
- data/lib/docspring/models/submission_state.rb +52 -0
- data/lib/docspring/models/template.rb +485 -766
- data/lib/docspring/models/{add_fields_data.rb → template_actor.rb} +119 -105
- data/lib/docspring/models/template_actor_type.rb +42 -0
- data/lib/docspring/models/template_defaults.rb +395 -0
- data/lib/docspring/models/template_defaults_input.rb +395 -0
- data/lib/docspring/models/template_document.rb +396 -0
- data/lib/docspring/models/template_document_state.rb +44 -0
- data/lib/docspring/models/{success_error_response.rb → template_field_dependency.rb} +122 -114
- data/lib/docspring/models/template_field_dependency_action.rb +42 -0
- data/lib/docspring/models/{create_pdf_template.rb → template_field_dependency_condition.rb} +116 -103
- data/lib/docspring/models/template_field_dependency_condition_input.rb +67 -0
- data/lib/docspring/models/template_field_dependency_input.rb +285 -0
- data/lib/docspring/models/template_field_dependency_match.rb +41 -0
- data/lib/docspring/models/template_field_dependency_operator.rb +49 -0
- data/lib/docspring/models/template_field_logic_status.rb +44 -0
- data/lib/docspring/models/template_form_mode.rb +42 -0
- data/lib/docspring/models/{template_model_code_response.rb → template_model_code.rb} +37 -96
- data/lib/docspring/models/template_page_ai_error.rb +43 -0
- data/lib/docspring/models/template_page_ai_naming_status.rb +41 -0
- data/lib/docspring/models/template_page_fields_status.rb +44 -0
- data/lib/docspring/models/template_page_image_status.rb +41 -0
- data/lib/docspring/models/template_page_processing_status.rb +275 -0
- data/lib/docspring/models/{create_webhook_data.rb → template_source_pdf.rb} +92 -103
- data/lib/docspring/models/{template_preview.rb → template_summary.rb} +436 -589
- data/lib/docspring/models/template_summary_list.rb +200 -0
- data/lib/docspring/models/template_type.rb +41 -0
- data/lib/docspring/models/template_version.rb +238 -0
- data/lib/docspring/models/template_version_type.rb +42 -0
- data/lib/docspring/models/text_alignment.rb +43 -0
- data/lib/docspring/models/text_overflow.rb +41 -0
- data/lib/docspring/models/text_vertical_alignment.rb +42 -0
- data/lib/docspring/models/typeface.rb +56 -0
- data/lib/docspring/models/{create_submission_data_request_data.rb → update_signature_request_request.rb} +72 -196
- data/lib/docspring/models/update_template_document_request.rb +205 -0
- data/lib/docspring/models/update_template_request.rb +514 -0
- data/lib/docspring/models/update_webhook_request.rb +344 -0
- data/lib/docspring/models/upload_method.rb +40 -0
- data/lib/docspring/models/{upload_presign_response.rb → upload_presign.rb} +93 -140
- data/lib/docspring/models/url_source_pdf.rb +212 -0
- data/lib/docspring/models/webhook.rb +97 -107
- data/lib/docspring/models/webhook_event_type.rb +64 -0
- data/lib/docspring/models/webhook_list.rb +200 -0
- data/lib/docspring/models/webhook_mode.rb +41 -0
- data/lib/docspring/request_schemas.json +3187 -0
- data/lib/docspring/request_validator.rb +396 -0
- data/lib/docspring/version.rb +4 -4
- data/lib/docspring.rb +125 -53
- data/spec/api/client_spec.rb +304 -277
- data/spec/models/ai_field_naming_language_spec.rb +30 -0
- data/spec/models/authentication_check_spec.rb +36 -0
- data/spec/models/barcode_symbology_spec.rb +30 -0
- data/spec/models/check_character_spec.rb +30 -0
- data/spec/models/combined_field_type_spec.rb +30 -0
- data/spec/models/combined_pdf_files_spec.rb +36 -0
- data/spec/models/combined_pdf_list_spec.rb +42 -0
- data/spec/models/combined_pdf_source_input_spec.rb +44 -0
- data/spec/models/combined_pdf_source_pdf_spec.rb +42 -0
- data/spec/models/{submission_data_request_token_spec.rb → combined_pdf_source_spec.rb} +18 -12
- data/spec/models/combined_pdf_source_type_spec.rb +30 -0
- data/spec/models/{combined_submission_spec.rb → combined_pdf_spec.rb} +20 -24
- data/spec/models/combined_pdf_state_spec.rb +30 -0
- data/spec/models/{copy_template_options_spec.rb → copy_template_request_spec.rb} +9 -9
- data/spec/models/{combine_pdfs_data_spec.rb → create_combined_pdf_request_spec.rb} +12 -18
- data/spec/models/{create_custom_file_data_spec.rb → create_custom_file_from_upload_request_spec.rb} +9 -9
- data/spec/models/{move_template_data_spec.rb → create_folder_request_spec.rb} +11 -11
- data/spec/models/{list_submissions_response_spec.rb → create_signature_request_event_request_spec.rb} +18 -12
- data/spec/models/create_signature_request_token_request_spec.rb +36 -0
- data/spec/models/{submission_batch_data_spec.rb → create_submission_batch_request_spec.rb} +13 -13
- data/spec/models/{create_pdf_submission_data_spec.rb → create_submission_request_spec.rb} +24 -18
- data/spec/models/{template_preview_spec.rb → create_template_request_spec.rb} +40 -118
- data/spec/models/create_webhook_request_spec.rb +96 -0
- data/spec/models/custom_file_list_spec.rb +42 -0
- data/spec/models/custom_file_source_pdf_spec.rb +42 -0
- data/spec/models/custom_file_spec.rb +29 -5
- data/spec/models/error_code_spec.rb +30 -0
- data/spec/models/{create_submission_response_spec.rb → error_detail_spec.rb} +14 -18
- data/spec/models/{batch_generate_pdfs201_response_spec.rb → error_info_spec.rb} +27 -19
- data/spec/models/error_response_spec.rb +4 -14
- data/spec/models/expiration_interval_spec.rb +30 -0
- data/spec/models/field_comparison_condition_spec.rb +48 -0
- data/spec/models/field_comparison_operator_spec.rb +30 -0
- data/spec/models/field_display_type_spec.rb +30 -0
- data/spec/models/field_equals_condition_spec.rb +48 -0
- data/spec/models/field_equals_operator_spec.rb +30 -0
- data/spec/models/field_in_condition_spec.rb +48 -0
- data/spec/models/field_override_spec.rb +408 -0
- data/spec/models/field_presence_condition_spec.rb +42 -0
- data/spec/models/field_presence_operator_spec.rb +30 -0
- data/spec/models/field_range_condition_spec.rb +54 -0
- data/spec/models/field_reimport_state_spec.rb +30 -0
- data/spec/models/field_setup_logic_spec.rb +30 -0
- data/spec/models/field_setup_naming_spec.rb +30 -0
- data/spec/models/field_setup_source_spec.rb +30 -0
- data/spec/models/folder_list_spec.rb +42 -0
- data/spec/models/folder_spec.rb +16 -4
- data/spec/models/generated_file_spec.rb +78 -0
- data/spec/models/generated_file_state_spec.rb +30 -0
- data/spec/models/html_engine_options_input_spec.rb +90 -0
- data/spec/models/html_engine_options_spec.rb +90 -0
- data/spec/models/image_gravity_spec.rb +30 -0
- data/spec/models/image_scale_type_spec.rb +30 -0
- data/spec/models/model_code_language_spec.rb +30 -0
- data/spec/models/move_folder_request_spec.rb +36 -0
- data/spec/models/move_template_request_spec.rb +36 -0
- data/spec/models/number_condition_type_spec.rb +30 -0
- data/spec/models/page_format_spec.rb +30 -0
- data/spec/models/{publish_version_data_spec.rb → publish_template_version_request_spec.rb} +11 -11
- data/spec/models/{rename_folder_data_spec.rb → rename_folder_request_spec.rb} +9 -9
- data/spec/models/restore_template_version_request_spec.rb +36 -0
- data/spec/models/shape_type_spec.rb +30 -0
- data/spec/models/signature_request_auth_second_factor_type_spec.rb +30 -0
- data/spec/models/signature_request_auth_type_spec.rb +30 -0
- data/spec/models/{submission_data_request_event_spec.rb → signature_request_event_spec.rb} +16 -18
- data/spec/models/signature_request_event_type_spec.rb +30 -0
- data/spec/models/{create_submission_data_request_data_spec.rb → signature_request_input_spec.rb} +28 -30
- data/spec/models/signature_request_message_type_spec.rb +30 -0
- data/spec/models/{submission_data_request_show_spec.rb → signature_request_spec.rb} +31 -31
- data/spec/models/signature_request_state_spec.rb +30 -0
- data/spec/models/signature_request_token_spec.rb +72 -0
- data/spec/models/signature_request_token_type_spec.rb +30 -0
- data/spec/models/string_condition_type_spec.rb +30 -0
- data/spec/models/submission_action_spec.rb +4 -22
- data/spec/models/submission_action_state_spec.rb +30 -0
- data/spec/models/submission_action_type_spec.rb +30 -0
- data/spec/models/submission_batch_spec.rb +27 -13
- data/spec/models/submission_batch_state_spec.rb +30 -0
- data/spec/models/submission_files_spec.rb +48 -0
- data/spec/models/submission_input_spec.rb +96 -0
- data/spec/models/submission_list_spec.rb +42 -0
- data/spec/models/submission_source_pdf_spec.rb +42 -0
- data/spec/models/submission_source_spec.rb +30 -0
- data/spec/models/submission_spec.rb +26 -56
- data/spec/models/submission_state_spec.rb +30 -0
- data/spec/models/template_actor_spec.rb +60 -0
- data/spec/models/template_actor_type_spec.rb +30 -0
- data/spec/models/{submission_data_request_spec.rb → template_defaults_input_spec.rb} +29 -53
- data/spec/models/template_defaults_spec.rb +150 -0
- data/spec/models/{json_schema_spec.rb → template_document_spec.rb} +21 -21
- data/spec/models/template_document_state_spec.rb +30 -0
- data/spec/models/template_field_dependency_action_spec.rb +30 -0
- data/spec/models/template_field_dependency_condition_input_spec.rb +44 -0
- data/spec/models/template_field_dependency_condition_spec.rb +54 -0
- data/spec/models/template_field_dependency_input_spec.rb +60 -0
- data/spec/models/template_field_dependency_match_spec.rb +30 -0
- data/spec/models/template_field_dependency_operator_spec.rb +30 -0
- data/spec/models/template_field_dependency_spec.rb +60 -0
- data/spec/models/template_field_logic_status_spec.rb +30 -0
- data/spec/models/template_form_mode_spec.rb +30 -0
- data/spec/models/{template_model_code_response_spec.rb → template_model_code_spec.rb} +9 -13
- data/spec/models/template_page_ai_error_spec.rb +30 -0
- data/spec/models/template_page_ai_naming_status_spec.rb +30 -0
- data/spec/models/template_page_fields_status_spec.rb +30 -0
- data/spec/models/template_page_image_status_spec.rb +30 -0
- data/spec/models/template_page_processing_status_spec.rb +60 -0
- data/spec/models/template_source_pdf_spec.rb +54 -0
- data/spec/models/template_spec.rb +40 -154
- data/spec/models/template_summary_list_spec.rb +42 -0
- data/spec/models/template_summary_spec.rb +252 -0
- data/spec/models/template_type_spec.rb +30 -0
- data/spec/models/template_version_spec.rb +54 -0
- data/spec/models/template_version_type_spec.rb +30 -0
- data/spec/models/text_alignment_spec.rb +30 -0
- data/spec/models/text_overflow_spec.rb +30 -0
- data/spec/models/text_vertical_alignment_spec.rb +30 -0
- data/spec/models/typeface_spec.rb +30 -0
- data/spec/models/{submission_batch_with_submissions_spec.rb → update_signature_request_request_spec.rb} +18 -22
- data/spec/models/update_template_document_request_spec.rb +48 -0
- data/spec/models/{submission_preview_spec.rb → update_template_request_spec.rb} +81 -41
- data/spec/models/update_webhook_request_spec.rb +96 -0
- data/spec/models/upload_method_spec.rb +30 -0
- data/spec/models/{upload_presign_response_spec.rb → upload_presign_spec.rb} +13 -17
- data/spec/models/url_source_pdf_spec.rb +42 -0
- data/spec/models/webhook_event_type_spec.rb +30 -0
- data/spec/models/webhook_list_spec.rb +42 -0
- data/spec/models/webhook_mode_spec.rb +30 -0
- data/spec/models/webhook_spec.rb +4 -8
- data/spec/spec_helper.rb +3 -3
- metadata +485 -202
- data/docs/AddFieldsData.md +0 -18
- data/docs/BatchGeneratePdfs201Response.md +0 -28
- data/docs/CombinePdfsData.md +0 -28
- data/docs/CombinedSubmission.md +0 -44
- data/docs/CombinedSubmissionAction.md +0 -30
- data/docs/CopyTemplateOptions.md +0 -22
- data/docs/CreateCombinedSubmissionResponse.md +0 -26
- data/docs/CreateCustomFileData.md +0 -18
- data/docs/CreateCustomFileResponse.md +0 -24
- data/docs/CreateHtmlTemplate.md +0 -18
- data/docs/CreatePdfSubmissionData.md +0 -34
- data/docs/CreatePdfTemplate.md +0 -18
- data/docs/CreateSubmissionDataRequestData.md +0 -44
- data/docs/CreateSubmissionDataRequestEventRequest.md +0 -24
- data/docs/CreateSubmissionDataRequestEventResponse.md +0 -24
- data/docs/CreateSubmissionDataRequestResponse.md +0 -24
- data/docs/CreateSubmissionDataRequestTokenResponse.md +0 -24
- data/docs/CreateSubmissionResponse.md +0 -26
- data/docs/ErrorOrMultipleErrorsResponse.md +0 -22
- data/docs/ForbiddenErrorResponse.md +0 -22
- data/docs/JsonSchema.md +0 -40
- data/docs/ListSubmissionsResponse.md +0 -22
- data/docs/MoveFolderData.md +0 -18
- data/docs/MoveTemplateData.md +0 -20
- data/docs/MultipleErrorsResponse.md +0 -20
- data/docs/PublishVersionData.md +0 -20
- data/docs/RestoreVersionData.md +0 -18
- data/docs/Submission422Response.md +0 -24
- data/docs/SubmissionBatchData.md +0 -26
- data/docs/SubmissionBatchWithSubmissions.md +0 -34
- data/docs/SubmissionDataRequest.md +0 -60
- data/docs/SubmissionDataRequestEvent.md +0 -30
- data/docs/SubmissionDataRequestShow.md +0 -62
- data/docs/SubmissionDataRequestToken.md +0 -24
- data/docs/SubmissionPreview.md +0 -64
- data/docs/SuccessErrorResponse.md +0 -20
- data/docs/SuccessMultipleErrorsResponse.md +0 -20
- data/docs/TemplateAddFieldsResponse.md +0 -22
- data/docs/TemplateDeleteResponse.md +0 -24
- data/docs/TemplateModelCodeResponse.md +0 -22
- data/docs/TemplatePreview.md +0 -116
- data/docs/TemplatePublishVersionResponse.md +0 -22
- data/docs/UpdateHtmlTemplate.md +0 -18
- data/docs/UpdatePdfTemplate.md +0 -18
- data/docs/UpdateSubmissionDataRequestData.md +0 -42
- data/docs/UploadPresignResponse.md +0 -24
- data/lib/docspring/models/batch_generate_pdfs201_response.rb +0 -352
- data/lib/docspring/models/combined_submission_action.rb +0 -384
- data/lib/docspring/models/create_combined_submission_response.rb +0 -324
- data/lib/docspring/models/create_custom_file_response.rb +0 -314
- data/lib/docspring/models/create_html_template.rb +0 -243
- data/lib/docspring/models/create_submission_data_request_event_response.rb +0 -314
- data/lib/docspring/models/create_submission_data_request_response.rb +0 -314
- data/lib/docspring/models/create_submission_data_request_token_response.rb +0 -314
- data/lib/docspring/models/create_submission_response.rb +0 -324
- data/lib/docspring/models/error_or_multiple_errors_response.rb +0 -290
- data/lib/docspring/models/forbidden_error_response.rb +0 -323
- data/lib/docspring/models/json_schema.rb +0 -329
- data/lib/docspring/models/list_submissions_response.rb +0 -283
- data/lib/docspring/models/multiple_errors_response.rb +0 -296
- data/lib/docspring/models/submission422_response.rb +0 -299
- data/lib/docspring/models/submission_batch_with_submissions.rb +0 -433
- data/lib/docspring/models/submission_data_request.rb +0 -570
- data/lib/docspring/models/submission_data_request_token.rb +0 -279
- data/lib/docspring/models/submission_preview.rb +0 -637
- data/lib/docspring/models/success_multiple_errors_response.rb +0 -279
- data/lib/docspring/models/template_add_fields_response.rb +0 -290
- data/lib/docspring/models/template_delete_response.rb +0 -300
- data/lib/docspring/models/template_publish_version_response.rb +0 -305
- data/lib/docspring/models/update_html_template.rb +0 -243
- data/lib/docspring/models/update_pdf_template.rb +0 -243
- data/spec/models/add_fields_data_spec.rb +0 -36
- data/spec/models/combined_submission_action_spec.rb +0 -84
- data/spec/models/create_combined_submission_response_spec.rb +0 -64
- data/spec/models/create_custom_file_response_spec.rb +0 -58
- data/spec/models/create_folder_data_spec.rb +0 -36
- data/spec/models/create_html_template_spec.rb +0 -36
- data/spec/models/create_pdf_template_spec.rb +0 -36
- data/spec/models/create_submission_data_request_event_request_spec.rb +0 -62
- data/spec/models/create_submission_data_request_event_response_spec.rb +0 -58
- data/spec/models/create_submission_data_request_response_spec.rb +0 -58
- data/spec/models/create_submission_data_request_token_response_spec.rb +0 -58
- data/spec/models/create_webhook_data_spec.rb +0 -36
- data/spec/models/error_or_multiple_errors_response_spec.rb +0 -52
- data/spec/models/forbidden_error_response_spec.rb +0 -56
- data/spec/models/move_folder_data_spec.rb +0 -36
- data/spec/models/multiple_errors_response_spec.rb +0 -46
- data/spec/models/restore_version_data_spec.rb +0 -36
- data/spec/models/submission422_response_spec.rb +0 -58
- data/spec/models/success_error_response_spec.rb +0 -46
- data/spec/models/success_multiple_errors_response_spec.rb +0 -46
- data/spec/models/template_add_fields_response_spec.rb +0 -52
- data/spec/models/template_delete_response_spec.rb +0 -58
- data/spec/models/template_publish_version_response_spec.rb +0 -52
- data/spec/models/update_html_template_spec.rb +0 -36
- data/spec/models/update_pdf_template_spec.rb +0 -36
- data/spec/models/update_submission_data_request_data_spec.rb +0 -116
- data/spec/models/update_webhook_data_spec.rb +0 -36
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DocSpring::CustomFileList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<CustomFile>**](CustomFile.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::CustomFileList.new(
|
|
16
|
+
data: null,
|
|
17
|
+
next_cursor: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DocSpring::CustomFileSourcePdf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Must be `custom_file`. | [default to 'custom_file'] |
|
|
8
|
+
| **id** | **String** | The ID of the submission, combined PDF, template or custom file. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'docspring'
|
|
14
|
+
|
|
15
|
+
instance = DocSpring::CustomFileSourcePdf.new(
|
|
16
|
+
type: null,
|
|
17
|
+
id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/ErrorCode.md
ADDED
data/docs/ErrorDetail.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# DocSpring::ErrorDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | What's wrong: `required`, `unknown_property`, `type`, `enum`, `format`, a JSON Schema keyword such as `minLength`, or a DocSpring code. New codes can be added. | |
|
|
8
|
+
| **message** | **String** | A human-readable explanation of the problem. | |
|
|
9
|
+
| **pointer** | **String** | A JSON pointer to the value in the request body (RFC 6901). An empty string means the whole body. In a submission's `data_errors`, it points into the request that created the submission. | [optional] |
|
|
10
|
+
| **parameter** | **String** | The query parameter the detail is about. | [optional] |
|
|
11
|
+
| **submission_id** | **String** | For a batch item that failed validation, the ID of the submission recorded for it. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'docspring'
|
|
17
|
+
|
|
18
|
+
instance = DocSpring::ErrorDetail.new(
|
|
19
|
+
code: null,
|
|
20
|
+
message: null,
|
|
21
|
+
pointer: null,
|
|
22
|
+
parameter: null,
|
|
23
|
+
submission_id: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/ErrorInfo.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# DocSpring::ErrorInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | [**ErrorCode**](ErrorCode.md) | 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`. `upgrade_required` (403): your plan doesn't include this, such as more templates or the embedded template editor. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the PDF wasn'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. | |
|
|
8
|
+
| **message** | **String** | A human-readable explanation, safe to show to developers. | |
|
|
9
|
+
| **details** | [**Array<ErrorDetail>**](ErrorDetail.md) | What was wrong with each part of the request. Empty when the error isn't about one part of it. | |
|
|
10
|
+
| **request_id** | **String** | The ID of the request. Include it when you contact support. | |
|
|
11
|
+
| **submission_id** | **String** | When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout`, the submission that's still being processed. | [optional] |
|
|
12
|
+
| **submission_batch_id** | **String** | The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout`, the batch that's still being processed. | [optional] |
|
|
13
|
+
| **combined_pdf_id** | **String** | With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed. | [optional] |
|
|
14
|
+
| **template_id** | **String** | With `polling_timeout`, the template whose PDF is still being processed. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'docspring'
|
|
20
|
+
|
|
21
|
+
instance = DocSpring::ErrorInfo.new(
|
|
22
|
+
code: null,
|
|
23
|
+
message: null,
|
|
24
|
+
details: null,
|
|
25
|
+
request_id: null,
|
|
26
|
+
submission_id: null,
|
|
27
|
+
submission_batch_id: null,
|
|
28
|
+
combined_pdf_id: null,
|
|
29
|
+
template_id: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
data/docs/ErrorResponse.md
CHANGED
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **error** | **String** | | |
|
|
7
|
+
| **error** | [**ErrorInfo**](ErrorInfo.md) | | |
|
|
9
8
|
|
|
10
9
|
## Example
|
|
11
10
|
|
|
@@ -13,7 +12,6 @@
|
|
|
13
12
|
require 'docspring'
|
|
14
13
|
|
|
15
14
|
instance = DocSpring::ErrorResponse.new(
|
|
16
|
-
status: null,
|
|
17
15
|
error: null
|
|
18
16
|
)
|
|
19
17
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# DocSpring::FieldComparisonCondition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | The name of the field whose value is compared. | |
|
|
8
|
+
| **operator** | [**FieldComparisonOperator**](FieldComparisonOperator.md) | How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`. | |
|
|
9
|
+
| **value** | **Object** | The number the field's value is compared with, or a number as a string (as the template editor saves it). The field must be a number field. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'docspring'
|
|
15
|
+
|
|
16
|
+
instance = DocSpring::FieldComparisonCondition.new(
|
|
17
|
+
field: null,
|
|
18
|
+
operator: null,
|
|
19
|
+
value: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DocSpring::FieldComparisonOperator
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'docspring'
|
|
12
|
+
|
|
13
|
+
instance = DocSpring::FieldComparisonOperator.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# DocSpring::FieldEqualsCondition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | The name of the field whose value is compared. | |
|
|
8
|
+
| **operator** | [**FieldEqualsOperator**](FieldEqualsOperator.md) | How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`. | |
|
|
9
|
+
| **value** | **Object** | The value the field's value is compared with. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'docspring'
|
|
15
|
+
|
|
16
|
+
instance = DocSpring::FieldEqualsCondition.new(
|
|
17
|
+
field: null,
|
|
18
|
+
operator: null,
|
|
19
|
+
value: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# DocSpring::FieldInCondition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | The name of the field whose value is compared. | |
|
|
8
|
+
| **operator** | **String** | Must be `in`. | [default to 'in'] |
|
|
9
|
+
| **value** | **Array<Object>** | The values the field's value must be one of. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'docspring'
|
|
15
|
+
|
|
16
|
+
instance = DocSpring::FieldInCondition.new(
|
|
17
|
+
field: null,
|
|
18
|
+
operator: null,
|
|
19
|
+
value: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# DocSpring::FieldOverride
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **static** | **Boolean** | Print the field's `default` (a fixed value, or a formula for a number field) on the PDF instead of a value from `data`. | [optional] |
|
|
8
|
+
| **editable** | **Boolean** | Keep this field fillable in the PDF instead of flattening it to text. The submission's `editable` overrides it. | [optional] |
|
|
9
|
+
| **default** | **String** | The value used when `data` has none for the field. | [optional] |
|
|
10
|
+
| **title** | **String** | The field's label on the signing form. | [optional] |
|
|
11
|
+
| **required** | **Boolean** | Whether `data` must have a value for the field. | [optional] |
|
|
12
|
+
| **option_list** | **String** | The values the field can take, separated by commas, such as `Yes,No`. Null allows any value. | [optional] |
|
|
13
|
+
| **combined_field_names** | **String** | The names of the fields a combined field joins, separated by commas. | [optional] |
|
|
14
|
+
| **combined_field_type** | [**CombinedFieldType**](CombinedFieldType.md) | How a combined field joins its fields' values. | [optional] |
|
|
15
|
+
| **combined_field_separator** | **String** | The text between the values of a combined field, such as `, `. | [optional] |
|
|
16
|
+
| **combined_field_format** | **String** | The text a combined field prints, with `$0`, `$1` and so on for its fields' values, such as `$0, $1`. | [optional] |
|
|
17
|
+
| **integer** | **Boolean** | Whether a number field takes only whole numbers. | [optional] |
|
|
18
|
+
| **include_time** | **Boolean** | Whether a date field takes a date and time (RFC 3339) rather than a date (YYYY-MM-DD). | [optional] |
|
|
19
|
+
| **signature_allow_draw** | **Boolean** | Let the person draw their signature or initials on the signing form. | [optional] |
|
|
20
|
+
| **signature_allow_type** | **Boolean** | Let the person type their signature or initials on the signing form. | [optional] |
|
|
21
|
+
| **barcode_symbology** | [**BarcodeSymbology**](BarcodeSymbology.md) | The kind of barcode a field with display_type `barcode` prints. | [optional] |
|
|
22
|
+
| **hidden** | **Boolean** | Leave the field off the PDF. Its value is still in the data, and combined fields can use it. | [optional] |
|
|
23
|
+
| **x** | **Float** | The distance from the left edge of the page, in the template editor's page units. | [optional] |
|
|
24
|
+
| **y** | **Float** | The distance from the top of the page, in the template editor's page units. | [optional] |
|
|
25
|
+
| **width** | **Float** | The field's width, in the template editor's page units. | [optional] |
|
|
26
|
+
| **height** | **Float** | The field's height, in the template editor's page units. | [optional] |
|
|
27
|
+
| **rotation** | **Float** | The field's rotation in degrees, clockwise. | [optional] |
|
|
28
|
+
| **display_type** | [**FieldDisplayType**](FieldDisplayType.md) | How the field's value is drawn on the PDF. | [optional] |
|
|
29
|
+
| **opacity** | **Float** | The field's opacity, from 0 (invisible) to 1 (solid). | [optional] |
|
|
30
|
+
| **date_time_format** | **String** | How a date field's value is printed, as a strftime format such as `%m/%d/%Y`. Null uses the template's date format. | [optional] |
|
|
31
|
+
| **typeface** | [**Typeface**](Typeface.md) | The font of the field's text. Null uses the template's default. | [optional] |
|
|
32
|
+
| **font_size** | **Integer** | The font size in points, a whole number. Null uses the template's default. | [optional] |
|
|
33
|
+
| **character_spacing** | **Float** | Extra space between characters, in points (0 to 50). | [optional] |
|
|
34
|
+
| **bold** | **Boolean** | Print the text in bold. | [optional] |
|
|
35
|
+
| **uppercase** | **Boolean** | Print the text in capitals. | [optional] |
|
|
36
|
+
| **strikethrough** | **Boolean** | Strike through the text. | [optional] |
|
|
37
|
+
| **keep_leading_spaces** | **Boolean** | Keep the spaces at the start of the text and of each line, so you can line text up with spaces. | [optional] |
|
|
38
|
+
| **overflow** | [**TextOverflow**](TextOverflow.md) | What happens to text that doesn't fit in the field. | [optional] |
|
|
39
|
+
| **multiline** | **Boolean** | Wrap the text over several lines when it doesn't fit on one. | [optional] |
|
|
40
|
+
| **multiline_lines** | **Integer** | The number of lines in a multiline field, for a PDF with ruled lines. Null for no fixed number of lines. | [optional] |
|
|
41
|
+
| **max_length** | **Integer** | The most characters the field takes. Null for no limit. | [optional] |
|
|
42
|
+
| **color** | **String** | The text color, as 6 hex digits without `#`, such as `444444`. Null uses the template's default. | [optional] |
|
|
43
|
+
| **background_color** | **String** | The field's background color, as 6 hex digits without `#`. Null for none. | [optional] |
|
|
44
|
+
| **alignment** | [**TextAlignment**](TextAlignment.md) | How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph. | [optional] |
|
|
45
|
+
| **v_alignment** | [**TextVerticalAlignment**](TextVerticalAlignment.md) | How text is aligned vertically in its field. | [optional] |
|
|
46
|
+
| **comb** | **Boolean** | Print one character in each of the field's equally spaced boxes (combs). | [optional] |
|
|
47
|
+
| **comb_number_of_cells** | **Integer** | The number of boxes in a comb field. | [optional] |
|
|
48
|
+
| **comb_value_offset** | **Integer** | The character of the value that the first box starts from, for a value split over several comb fields (such as the parts of a Social Security number). | [optional] |
|
|
49
|
+
| **shape_type** | [**ShapeType**](ShapeType.md) | The shape a field with display_type `shape` draws. | [optional] |
|
|
50
|
+
| **shape_sides** | **Integer** | The number of sides of a `polygon` shape. | [optional] |
|
|
51
|
+
| **shape_border_width** | **Integer** | The width of a shape's border, in points, a whole number. | [optional] |
|
|
52
|
+
| **shape_border_color** | **String** | The color of a shape's border, as 6 hex digits without `#`. | [optional] |
|
|
53
|
+
| **shape_fill_color** | **String** | The color a shape is filled with, as 6 hex digits without `#`. Null for no fill. | [optional] |
|
|
54
|
+
| **check_character** | [**CheckCharacter**](CheckCharacter.md) | The character that a ticked check box prints. | [optional] |
|
|
55
|
+
| **check_color** | **String** | The color of the check mark, as 6 hex digits without `#`. Null uses the template's default. | [optional] |
|
|
56
|
+
| **qrcode_color** | **String** | The color of a QR code, as 6 hex digits without `#`. Null for black. | [optional] |
|
|
57
|
+
| **true_text** | **String** | What a boolean field with display_type `text` prints for `true`. | [optional] |
|
|
58
|
+
| **false_text** | **String** | What a boolean field with display_type `text` prints for `false`. | [optional] |
|
|
59
|
+
| **condition** | **String** | The value a check mark or shape is drawn for: it's drawn when the field's value matches, as `string_condition_type` or `number_condition_type` says. | [optional] |
|
|
60
|
+
| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | How a string field's value is compared with `condition`. | [optional] |
|
|
61
|
+
| **number_condition_type** | [**NumberConditionType**](NumberConditionType.md) | How a number field's value is compared with `condition`, or with `number_condition_range_min` and `number_condition_range_max` for `range`. | [optional] |
|
|
62
|
+
| **number_condition_range_min** | **Float** | The lower end of a `range` condition. | [optional] |
|
|
63
|
+
| **number_condition_range_max** | **Float** | The upper end of a `range` condition. | [optional] |
|
|
64
|
+
| **number_condition_range_exclusive_min** | **Boolean** | Leave the lower end itself out of a `range` condition. | [optional] |
|
|
65
|
+
| **number_condition_range_exclusive_max** | **Boolean** | Leave the upper end itself out of a `range` condition. | [optional] |
|
|
66
|
+
| **invert_boolean_condition** | **Boolean** | Draw a boolean field's check mark or shape for `false` instead of `true`. | [optional] |
|
|
67
|
+
| **decimal_places** | **Integer** | The number of decimal places a number field prints. Null prints the value as it was sent. | [optional] |
|
|
68
|
+
| **image_scale_type** | [**ImageScaleType**](ImageScaleType.md) | How an image is resized to its field. | [optional] |
|
|
69
|
+
| **image_gravity** | [**ImageGravity**](ImageGravity.md) | Where an image sits in its field when it doesn't fill it, or which part is kept when it's cropped. | [optional] |
|
|
70
|
+
|
|
71
|
+
## Example
|
|
72
|
+
|
|
73
|
+
```ruby
|
|
74
|
+
require 'docspring'
|
|
75
|
+
|
|
76
|
+
instance = DocSpring::FieldOverride.new(
|
|
77
|
+
static: null,
|
|
78
|
+
editable: null,
|
|
79
|
+
default: null,
|
|
80
|
+
title: null,
|
|
81
|
+
required: null,
|
|
82
|
+
option_list: null,
|
|
83
|
+
combined_field_names: null,
|
|
84
|
+
combined_field_type: null,
|
|
85
|
+
combined_field_separator: null,
|
|
86
|
+
combined_field_format: null,
|
|
87
|
+
integer: null,
|
|
88
|
+
include_time: null,
|
|
89
|
+
signature_allow_draw: null,
|
|
90
|
+
signature_allow_type: null,
|
|
91
|
+
barcode_symbology: null,
|
|
92
|
+
hidden: null,
|
|
93
|
+
x: null,
|
|
94
|
+
y: null,
|
|
95
|
+
width: null,
|
|
96
|
+
height: null,
|
|
97
|
+
rotation: null,
|
|
98
|
+
display_type: null,
|
|
99
|
+
opacity: null,
|
|
100
|
+
date_time_format: null,
|
|
101
|
+
typeface: null,
|
|
102
|
+
font_size: null,
|
|
103
|
+
character_spacing: null,
|
|
104
|
+
bold: null,
|
|
105
|
+
uppercase: null,
|
|
106
|
+
strikethrough: null,
|
|
107
|
+
keep_leading_spaces: null,
|
|
108
|
+
overflow: null,
|
|
109
|
+
multiline: null,
|
|
110
|
+
multiline_lines: null,
|
|
111
|
+
max_length: null,
|
|
112
|
+
color: null,
|
|
113
|
+
background_color: null,
|
|
114
|
+
alignment: null,
|
|
115
|
+
v_alignment: null,
|
|
116
|
+
comb: null,
|
|
117
|
+
comb_number_of_cells: null,
|
|
118
|
+
comb_value_offset: null,
|
|
119
|
+
shape_type: null,
|
|
120
|
+
shape_sides: null,
|
|
121
|
+
shape_border_width: null,
|
|
122
|
+
shape_border_color: null,
|
|
123
|
+
shape_fill_color: null,
|
|
124
|
+
check_character: null,
|
|
125
|
+
check_color: null,
|
|
126
|
+
qrcode_color: null,
|
|
127
|
+
true_text: null,
|
|
128
|
+
false_text: null,
|
|
129
|
+
condition: null,
|
|
130
|
+
string_condition_type: null,
|
|
131
|
+
number_condition_type: null,
|
|
132
|
+
number_condition_range_min: null,
|
|
133
|
+
number_condition_range_max: null,
|
|
134
|
+
number_condition_range_exclusive_min: null,
|
|
135
|
+
number_condition_range_exclusive_max: null,
|
|
136
|
+
invert_boolean_condition: null,
|
|
137
|
+
decimal_places: null,
|
|
138
|
+
image_scale_type: null,
|
|
139
|
+
image_gravity: null
|
|
140
|
+
)
|
|
141
|
+
```
|
|
142
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DocSpring::FieldPresenceCondition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | The name of the field whose value is compared. | |
|
|
8
|
+
| **operator** | [**FieldPresenceOperator**](FieldPresenceOperator.md) | How the field's value is compared with `value`. `in`: one of a list. `range`: from `value` to `range_max`. | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'docspring'
|
|
14
|
+
|
|
15
|
+
instance = DocSpring::FieldPresenceCondition.new(
|
|
16
|
+
field: null,
|
|
17
|
+
operator: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DocSpring::FieldPresenceOperator
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'docspring'
|
|
12
|
+
|
|
13
|
+
instance = DocSpring::FieldPresenceOperator.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# DocSpring::FieldRangeCondition
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | The name of the field whose value is compared. | |
|
|
8
|
+
| **operator** | **String** | Must be `range`. | [default to 'range'] |
|
|
9
|
+
| **value** | **Object** | The lower end of the range, a number (or a number as a string, as the template editor saves it). Null or left out for no lower end. A range needs `value`, `range_max` or both. | [optional] |
|
|
10
|
+
| **range_max** | **Object** | The upper end of the range, a number (or a number as a string, as the template editor saves it). Null or left out for no upper end. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'docspring'
|
|
16
|
+
|
|
17
|
+
instance = DocSpring::FieldRangeCondition.new(
|
|
18
|
+
field: null,
|
|
19
|
+
operator: null,
|
|
20
|
+
value: null,
|
|
21
|
+
range_max: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/Folder.md
CHANGED
|
@@ -4,10 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **id** | **String** |
|
|
8
|
-
| **name** | **String** |
|
|
9
|
-
| **path** | **String** |
|
|
10
|
-
| **parent_folder_id** | **String** |
|
|
7
|
+
| **id** | **String** | The folder's ID. | |
|
|
8
|
+
| **name** | **String** | The folder's name. It can't contain `/`, and is unique within its parent folder. | |
|
|
9
|
+
| **path** | **String** | The path of the folder this folder is in, such as `/Contracts`. `/` for a folder at the root. | |
|
|
10
|
+
| **parent_folder_id** | **String** | The ID of the folder this folder is in. Null for a folder at the root. | |
|
|
11
|
+
| **created_at** | **Time** | When the folder was created. | |
|
|
12
|
+
| **updated_at** | **Time** | When the folder was last updated. | |
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -18,7 +20,9 @@ instance = DocSpring::Folder.new(
|
|
|
18
20
|
id: null,
|
|
19
21
|
name: null,
|
|
20
22
|
path: null,
|
|
21
|
-
parent_folder_id: null
|
|
23
|
+
parent_folder_id: null,
|
|
24
|
+
created_at: null,
|
|
25
|
+
updated_at: null
|
|
22
26
|
)
|
|
23
27
|
```
|
|
24
28
|
|
data/docs/FolderList.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DocSpring::FolderList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<Folder>**](Folder.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::FolderList.new(
|
|
16
|
+
data: null,
|
|
17
|
+
next_cursor: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# DocSpring::GeneratedFile
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **state** | [**GeneratedFileState**](GeneratedFileState.md) | `processed` once the file has been made. `pending` while it's being made, and `error` if it couldn't be made (see `error_message`). | |
|
|
8
|
+
| **error_message** | **String** | Why the file couldn't be made, when `state` is `error`. | |
|
|
9
|
+
| **download_url** | **String** | A temporary link to download the file. Null until the file has been made, and when your account turns off download links for submissions. | |
|
|
10
|
+
| **permanent_url** | **String** | A link to download the file that doesn't expire: it redirects to a new temporary link. It needs your API token or a signed-in session, except for a submission of a template that makes its submissions public. Null until the file has been made. | |
|
|
11
|
+
| **filename** | **String** | The file's name, such as `sub_123.pdf`. | |
|
|
12
|
+
| **content_type** | **String** | The file's media type, such as `application/pdf`. | |
|
|
13
|
+
| **size** | **Integer** | The file's size in bytes. Null until the file has been made. | |
|
|
14
|
+
| **sha256** | **String** | The SHA-256 hash of the file. Null until the file has been made. | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'docspring'
|
|
20
|
+
|
|
21
|
+
instance = DocSpring::GeneratedFile.new(
|
|
22
|
+
state: null,
|
|
23
|
+
error_message: null,
|
|
24
|
+
download_url: null,
|
|
25
|
+
permanent_url: null,
|
|
26
|
+
filename: null,
|
|
27
|
+
content_type: null,
|
|
28
|
+
size: null,
|
|
29
|
+
sha256: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|