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
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#DocSpring API
|
|
3
|
+
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: v2
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.26.0-DOCSPRING
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module DocSpring
|
|
17
|
+
# One of a template's signer roles: someone who fills in or signs its fields.
|
|
18
|
+
class TemplateSignerRole < ApiModelBase
|
|
19
|
+
# The role's ID, which never changes: fields refer to their role by it, so changing the role's key or name, or moving it in the list, keeps its fields. Leave it out for a new role. A role keeps the ID you give it, so roles copied from another template with their IDs keep the fields copied with them.
|
|
20
|
+
attr_accessor :id
|
|
21
|
+
|
|
22
|
+
# The role's name in the API and in the template's code, in snake_case: `role: tenant` on a field tag, a field's `signer_role`, a signature request's `role`, and `@@signature_requests/tenant/...` fields. Each role has its own, and `sender` is taken (it marks the fields that submission data fills in). Left out, it's made from `name`: Co-tenant 2 is `co_tenant_2`.
|
|
23
|
+
attr_accessor :key
|
|
24
|
+
|
|
25
|
+
# The role's name, such as Tenant, which the template editor shows. Each role has its own, and `Signer N` can only be role N's.
|
|
26
|
+
attr_accessor :name
|
|
27
|
+
|
|
28
|
+
# The signer's name, for a signature request that doesn't give one: a fixed name, or text and `{{ variables }}` that name a path into the submission's data, such as `{{ tenant.name }}` or `{{ tenant.first_name }} {{ tenant.last_name }}`. No filters or tags. Each variable is one of the template's fields, unless the template allows additional properties: setting one that isn't is a `422`. A value the data doesn't have prints nothing, and a name that comes out blank is left out. Null for none.
|
|
29
|
+
attr_accessor :name_expression
|
|
30
|
+
|
|
31
|
+
# The signer's email address, for a signature request that doesn't give one: a fixed address, such as `leasing@example.com`, or one from the submission's data, written like `name_expression`: `{{ tenant.email }}`. The data has to have the value, so it's one of the template's fields (one the sender fills in) or the template allows additional properties: setting a variable that isn't a field is a `422` otherwise. Null for none.
|
|
32
|
+
attr_accessor :email_expression
|
|
33
|
+
|
|
34
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
35
|
+
def self.attribute_map
|
|
36
|
+
{
|
|
37
|
+
:'id' => :'id',
|
|
38
|
+
:'key' => :'key',
|
|
39
|
+
:'name' => :'name',
|
|
40
|
+
:'name_expression' => :'name_expression',
|
|
41
|
+
:'email_expression' => :'email_expression'
|
|
42
|
+
}
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Returns attribute mapping this model knows about
|
|
46
|
+
def self.acceptable_attribute_map
|
|
47
|
+
attribute_map
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Returns all the JSON keys this model knows about
|
|
51
|
+
def self.acceptable_attributes
|
|
52
|
+
acceptable_attribute_map.values
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Attribute type mapping.
|
|
56
|
+
def self.openapi_types
|
|
57
|
+
{
|
|
58
|
+
:'id' => :'String',
|
|
59
|
+
:'key' => :'String',
|
|
60
|
+
:'name' => :'String',
|
|
61
|
+
:'name_expression' => :'String',
|
|
62
|
+
:'email_expression' => :'String'
|
|
63
|
+
}
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# List of attributes with nullable: true
|
|
67
|
+
def self.openapi_nullable
|
|
68
|
+
Set.new([
|
|
69
|
+
:'name_expression',
|
|
70
|
+
:'email_expression'
|
|
71
|
+
])
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Returns attribute type mapping
|
|
75
|
+
def self.acceptable_openapi_types
|
|
76
|
+
openapi_types
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Returns the nullable attributes
|
|
80
|
+
def self.acceptable_openapi_nullable
|
|
81
|
+
openapi_nullable
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Initializes the object
|
|
85
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
86
|
+
def initialize(attributes = {})
|
|
87
|
+
if (!attributes.is_a?(Hash))
|
|
88
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::TemplateSignerRole` initialize method"
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
92
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
93
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
94
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
95
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::TemplateSignerRole`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
96
|
+
end
|
|
97
|
+
h[k.to_sym] = v
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
if attributes.key?(:'id')
|
|
101
|
+
self.id = attributes[:'id']
|
|
102
|
+
else
|
|
103
|
+
self.id = nil
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
if attributes.key?(:'key')
|
|
107
|
+
self.key = attributes[:'key']
|
|
108
|
+
else
|
|
109
|
+
self.key = nil
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
if attributes.key?(:'name')
|
|
113
|
+
self.name = attributes[:'name']
|
|
114
|
+
else
|
|
115
|
+
self.name = nil
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
if attributes.key?(:'name_expression')
|
|
119
|
+
self.name_expression = attributes[:'name_expression']
|
|
120
|
+
else
|
|
121
|
+
self.name_expression = nil
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
if attributes.key?(:'email_expression')
|
|
125
|
+
self.email_expression = attributes[:'email_expression']
|
|
126
|
+
else
|
|
127
|
+
self.email_expression = nil
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
132
|
+
# @return Array for valid properties with the reasons
|
|
133
|
+
def list_invalid_properties
|
|
134
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
135
|
+
invalid_properties = Array.new
|
|
136
|
+
if @id.nil?
|
|
137
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
if @key.nil?
|
|
141
|
+
invalid_properties.push('invalid value for "key", key cannot be nil.')
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
if @name.nil?
|
|
145
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
invalid_properties
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# Check to see if the all the properties in the model are valid
|
|
152
|
+
# @return true if the model is valid
|
|
153
|
+
def valid?
|
|
154
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
155
|
+
return false if @id.nil?
|
|
156
|
+
return false if @key.nil?
|
|
157
|
+
return false if @name.nil?
|
|
158
|
+
true
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# Custom attribute writer method with validation
|
|
162
|
+
# @param [Object] id Value to be assigned
|
|
163
|
+
def id=(id)
|
|
164
|
+
if id.nil?
|
|
165
|
+
fail ArgumentError, 'id cannot be nil'
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
@id = id
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Custom attribute writer method with validation
|
|
172
|
+
# @param [Object] key Value to be assigned
|
|
173
|
+
def key=(key)
|
|
174
|
+
if key.nil?
|
|
175
|
+
fail ArgumentError, 'key cannot be nil'
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
@key = key
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# Custom attribute writer method with validation
|
|
182
|
+
# @param [Object] name Value to be assigned
|
|
183
|
+
def name=(name)
|
|
184
|
+
if name.nil?
|
|
185
|
+
fail ArgumentError, 'name cannot be nil'
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
@name = name
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Checks equality by comparing each attribute.
|
|
192
|
+
# @param [Object] Object to be compared
|
|
193
|
+
def ==(o)
|
|
194
|
+
return true if self.equal?(o)
|
|
195
|
+
self.class == o.class &&
|
|
196
|
+
id == o.id &&
|
|
197
|
+
key == o.key &&
|
|
198
|
+
name == o.name &&
|
|
199
|
+
name_expression == o.name_expression &&
|
|
200
|
+
email_expression == o.email_expression
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# @see the `==` method
|
|
204
|
+
# @param [Object] Object to be compared
|
|
205
|
+
def eql?(o)
|
|
206
|
+
self == o
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Calculates hash code according to all attributes.
|
|
210
|
+
# @return [Integer] Hash code
|
|
211
|
+
def hash
|
|
212
|
+
[id, key, name, name_expression, email_expression].hash
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# Builds the object from hash
|
|
216
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
217
|
+
# @return [Object] Returns the model itself
|
|
218
|
+
def self.build_from_hash(attributes)
|
|
219
|
+
return nil unless attributes.is_a?(Hash)
|
|
220
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
221
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
222
|
+
map = acceptable_attribute_map
|
|
223
|
+
transformed_hash = {}
|
|
224
|
+
acceptable_openapi_types.each_pair do |key, type|
|
|
225
|
+
if attributes.key?(map[key]) && attributes[map[key]].nil?
|
|
226
|
+
transformed_hash["#{key}"] = nil
|
|
227
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
228
|
+
# check to ensure the input is an array given that the attribute
|
|
229
|
+
# is documented as an array but the input is not
|
|
230
|
+
if attributes[map[key]].is_a?(Array)
|
|
231
|
+
transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
|
|
232
|
+
end
|
|
233
|
+
elsif !attributes[map[key]].nil?
|
|
234
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
|
|
235
|
+
end
|
|
236
|
+
end
|
|
237
|
+
# Responses can include enum values added after this client was released, so the enum setters
|
|
238
|
+
# accept any value while the model is built from a response
|
|
239
|
+
allocate.tap do |model|
|
|
240
|
+
model.instance_variable_set(:@_skip_enum_validation, true)
|
|
241
|
+
model.send(:initialize, transformed_hash)
|
|
242
|
+
model.remove_instance_variable(:@_skip_enum_validation)
|
|
243
|
+
end
|
|
244
|
+
end
|
|
245
|
+
|
|
246
|
+
# Returns the object in the form of hash
|
|
247
|
+
# @return [Hash] Returns the object in the form of hash
|
|
248
|
+
def to_hash
|
|
249
|
+
hash = {}
|
|
250
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
251
|
+
self.class.acceptable_attribute_map.each_pair do |attr, param|
|
|
252
|
+
value = self.send(attr)
|
|
253
|
+
if value.nil?
|
|
254
|
+
is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
|
|
255
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
hash[param] = _to_hash(value)
|
|
259
|
+
end
|
|
260
|
+
hash
|
|
261
|
+
end
|
|
262
|
+
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
end
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#DocSpring API
|
|
3
|
+
|
|
4
|
+
#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: v2
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.26.0-DOCSPRING
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module DocSpring
|
|
17
|
+
# One of a template's signer roles: someone who fills in or signs its fields.
|
|
18
|
+
class TemplateSignerRoleInput < ApiModelBase
|
|
19
|
+
# The role's ID, which never changes: fields refer to their role by it, so changing the role's key or name, or moving it in the list, keeps its fields. Leave it out for a new role. A role keeps the ID you give it, so roles copied from another template with their IDs keep the fields copied with them.
|
|
20
|
+
attr_accessor :id
|
|
21
|
+
|
|
22
|
+
# The role's name in the API and in the template's code, in snake_case: `role: tenant` on a field tag, a field's `signer_role`, a signature request's `role`, and `@@signature_requests/tenant/...` fields. Each role has its own, and `sender` is taken (it marks the fields that submission data fills in). Left out, it's made from `name`: Co-tenant 2 is `co_tenant_2`.
|
|
23
|
+
attr_accessor :key
|
|
24
|
+
|
|
25
|
+
# The role's name, such as Tenant, which the template editor shows. Each role has its own, and `Signer N` can only be role N's.
|
|
26
|
+
attr_accessor :name
|
|
27
|
+
|
|
28
|
+
# The signer's name, for a signature request that doesn't give one: a fixed name, or text and `{{ variables }}` that name a path into the submission's data, such as `{{ tenant.name }}` or `{{ tenant.first_name }} {{ tenant.last_name }}`. No filters or tags. Each variable is one of the template's fields, unless the template allows additional properties: setting one that isn't is a `422`. A value the data doesn't have prints nothing, and a name that comes out blank is left out. Null for none.
|
|
29
|
+
attr_accessor :name_expression
|
|
30
|
+
|
|
31
|
+
# The signer's email address, for a signature request that doesn't give one: a fixed address, such as `leasing@example.com`, or one from the submission's data, written like `name_expression`: `{{ tenant.email }}`. The data has to have the value, so it's one of the template's fields (one the sender fills in) or the template allows additional properties: setting a variable that isn't a field is a `422` otherwise. Null for none.
|
|
32
|
+
attr_accessor :email_expression
|
|
33
|
+
|
|
34
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
35
|
+
def self.attribute_map
|
|
36
|
+
{
|
|
37
|
+
:'id' => :'id',
|
|
38
|
+
:'key' => :'key',
|
|
39
|
+
:'name' => :'name',
|
|
40
|
+
:'name_expression' => :'name_expression',
|
|
41
|
+
:'email_expression' => :'email_expression'
|
|
42
|
+
}
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# Returns attribute mapping this model knows about
|
|
46
|
+
def self.acceptable_attribute_map
|
|
47
|
+
attribute_map
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Returns all the JSON keys this model knows about
|
|
51
|
+
def self.acceptable_attributes
|
|
52
|
+
acceptable_attribute_map.values
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Attribute type mapping.
|
|
56
|
+
def self.openapi_types
|
|
57
|
+
{
|
|
58
|
+
:'id' => :'String',
|
|
59
|
+
:'key' => :'String',
|
|
60
|
+
:'name' => :'String',
|
|
61
|
+
:'name_expression' => :'String',
|
|
62
|
+
:'email_expression' => :'String'
|
|
63
|
+
}
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# List of attributes with nullable: true
|
|
67
|
+
def self.openapi_nullable
|
|
68
|
+
Set.new([
|
|
69
|
+
:'name_expression',
|
|
70
|
+
:'email_expression'
|
|
71
|
+
])
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
# Returns attribute type mapping
|
|
75
|
+
def self.acceptable_openapi_types
|
|
76
|
+
openapi_types
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Returns the nullable attributes
|
|
80
|
+
def self.acceptable_openapi_nullable
|
|
81
|
+
openapi_nullable
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Initializes the object
|
|
85
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
86
|
+
def initialize(attributes = {})
|
|
87
|
+
if (!attributes.is_a?(Hash))
|
|
88
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::TemplateSignerRoleInput` initialize method"
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
92
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
93
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
94
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
95
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::TemplateSignerRoleInput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
96
|
+
end
|
|
97
|
+
h[k.to_sym] = v
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
if attributes.key?(:'id')
|
|
101
|
+
self.id = attributes[:'id']
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
if attributes.key?(:'key')
|
|
105
|
+
self.key = attributes[:'key']
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
if attributes.key?(:'name')
|
|
109
|
+
self.name = attributes[:'name']
|
|
110
|
+
else
|
|
111
|
+
self.name = nil
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
if attributes.key?(:'name_expression')
|
|
115
|
+
self.name_expression = attributes[:'name_expression']
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
if attributes.key?(:'email_expression')
|
|
119
|
+
self.email_expression = attributes[:'email_expression']
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
124
|
+
# @return Array for valid properties with the reasons
|
|
125
|
+
def list_invalid_properties
|
|
126
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
127
|
+
invalid_properties = Array.new
|
|
128
|
+
if @name.nil?
|
|
129
|
+
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
invalid_properties
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Check to see if the all the properties in the model are valid
|
|
136
|
+
# @return true if the model is valid
|
|
137
|
+
def valid?
|
|
138
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
139
|
+
return false if @name.nil?
|
|
140
|
+
true
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
# Custom attribute writer method with validation
|
|
144
|
+
# @param [Object] name Value to be assigned
|
|
145
|
+
def name=(name)
|
|
146
|
+
if name.nil?
|
|
147
|
+
fail ArgumentError, 'name cannot be nil'
|
|
148
|
+
end
|
|
149
|
+
|
|
150
|
+
@name = name
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# Checks equality by comparing each attribute.
|
|
154
|
+
# @param [Object] Object to be compared
|
|
155
|
+
def ==(o)
|
|
156
|
+
return true if self.equal?(o)
|
|
157
|
+
self.class == o.class &&
|
|
158
|
+
id == o.id &&
|
|
159
|
+
key == o.key &&
|
|
160
|
+
name == o.name &&
|
|
161
|
+
name_expression == o.name_expression &&
|
|
162
|
+
email_expression == o.email_expression
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# @see the `==` method
|
|
166
|
+
# @param [Object] Object to be compared
|
|
167
|
+
def eql?(o)
|
|
168
|
+
self == o
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# Calculates hash code according to all attributes.
|
|
172
|
+
# @return [Integer] Hash code
|
|
173
|
+
def hash
|
|
174
|
+
[id, key, name, name_expression, email_expression].hash
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
# Builds the object from hash
|
|
178
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
179
|
+
# @return [Object] Returns the model itself
|
|
180
|
+
def self.build_from_hash(attributes)
|
|
181
|
+
return nil unless attributes.is_a?(Hash)
|
|
182
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
183
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
184
|
+
map = acceptable_attribute_map
|
|
185
|
+
transformed_hash = {}
|
|
186
|
+
acceptable_openapi_types.each_pair do |key, type|
|
|
187
|
+
if attributes.key?(map[key]) && attributes[map[key]].nil?
|
|
188
|
+
transformed_hash["#{key}"] = nil
|
|
189
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
190
|
+
# check to ensure the input is an array given that the attribute
|
|
191
|
+
# is documented as an array but the input is not
|
|
192
|
+
if attributes[map[key]].is_a?(Array)
|
|
193
|
+
transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
|
|
194
|
+
end
|
|
195
|
+
elsif !attributes[map[key]].nil?
|
|
196
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
|
|
197
|
+
end
|
|
198
|
+
end
|
|
199
|
+
# Responses can include enum values added after this client was released, so the enum setters
|
|
200
|
+
# accept any value while the model is built from a response
|
|
201
|
+
allocate.tap do |model|
|
|
202
|
+
model.instance_variable_set(:@_skip_enum_validation, true)
|
|
203
|
+
model.send(:initialize, transformed_hash)
|
|
204
|
+
model.remove_instance_variable(:@_skip_enum_validation)
|
|
205
|
+
end
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
# Returns the object in the form of hash
|
|
209
|
+
# @return [Hash] Returns the object in the form of hash
|
|
210
|
+
def to_hash
|
|
211
|
+
hash = {}
|
|
212
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
213
|
+
self.class.acceptable_attribute_map.each_pair do |attr, param|
|
|
214
|
+
value = self.send(attr)
|
|
215
|
+
if value.nil?
|
|
216
|
+
is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
|
|
217
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
hash[param] = _to_hash(value)
|
|
221
|
+
end
|
|
222
|
+
hash
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
end
|
|
@@ -58,7 +58,7 @@ module DocSpring
|
|
|
58
58
|
# Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
|
|
59
59
|
attr_accessor :file_formats
|
|
60
60
|
|
|
61
|
-
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
|
|
61
|
+
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days, or until the submission expires if that's sooner. Accounts with a BAA start with `link`.
|
|
62
62
|
attr_accessor :delivery
|
|
63
63
|
|
|
64
64
|
# With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
|
|
@@ -49,7 +49,7 @@ module DocSpring
|
|
|
49
49
|
# Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
|
|
50
50
|
attr_accessor :file_formats
|
|
51
51
|
|
|
52
|
-
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
|
|
52
|
+
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days, or until the submission expires if that's sooner. Accounts with a BAA start with `link`.
|
|
53
53
|
attr_accessor :delivery
|
|
54
54
|
|
|
55
55
|
# With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
|
|
@@ -52,7 +52,7 @@ module DocSpring
|
|
|
52
52
|
# Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
|
|
53
53
|
attr_accessor :file_formats
|
|
54
54
|
|
|
55
|
-
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
|
|
55
|
+
# `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days, or until the submission expires if that's sooner. Accounts with a BAA start with `link`.
|
|
56
56
|
attr_accessor :delivery
|
|
57
57
|
|
|
58
58
|
# With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
|
|
@@ -31,6 +31,9 @@ module DocSpring
|
|
|
31
31
|
# Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
|
|
32
32
|
attr_accessor :reimport_fields
|
|
33
33
|
|
|
34
|
+
# Add a field for each value the template's code, Word document or layout reads for the first time, with a type worked out from how it's used. Existing fields keep their settings, and a field you deleted while the code still read the value stays deleted. Default true. Set it to false to manage the fields yourself with the fields endpoints: a form field whose field isn't on the template then fails its submissions and previews. Only for HTML templates, Word templates and page designs.
|
|
35
|
+
attr_accessor :sync_fields
|
|
36
|
+
|
|
34
37
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
35
38
|
def self.attribute_map
|
|
36
39
|
{
|
|
@@ -38,7 +41,8 @@ module DocSpring
|
|
|
38
41
|
:'document_url' => :'document_url',
|
|
39
42
|
:'document_base64' => :'document_base64',
|
|
40
43
|
:'filename' => :'filename',
|
|
41
|
-
:'reimport_fields' => :'reimport_fields'
|
|
44
|
+
:'reimport_fields' => :'reimport_fields',
|
|
45
|
+
:'sync_fields' => :'sync_fields'
|
|
42
46
|
}
|
|
43
47
|
end
|
|
44
48
|
|
|
@@ -59,7 +63,8 @@ module DocSpring
|
|
|
59
63
|
:'document_url' => :'String',
|
|
60
64
|
:'document_base64' => :'String',
|
|
61
65
|
:'filename' => :'String',
|
|
62
|
-
:'reimport_fields' => :'Boolean'
|
|
66
|
+
:'reimport_fields' => :'Boolean',
|
|
67
|
+
:'sync_fields' => :'Boolean'
|
|
63
68
|
}
|
|
64
69
|
end
|
|
65
70
|
|
|
@@ -114,6 +119,10 @@ module DocSpring
|
|
|
114
119
|
if attributes.key?(:'reimport_fields')
|
|
115
120
|
self.reimport_fields = attributes[:'reimport_fields']
|
|
116
121
|
end
|
|
122
|
+
|
|
123
|
+
if attributes.key?(:'sync_fields')
|
|
124
|
+
self.sync_fields = attributes[:'sync_fields']
|
|
125
|
+
end
|
|
117
126
|
end
|
|
118
127
|
|
|
119
128
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -140,7 +149,8 @@ module DocSpring
|
|
|
140
149
|
document_url == o.document_url &&
|
|
141
150
|
document_base64 == o.document_base64 &&
|
|
142
151
|
filename == o.filename &&
|
|
143
|
-
reimport_fields == o.reimport_fields
|
|
152
|
+
reimport_fields == o.reimport_fields &&
|
|
153
|
+
sync_fields == o.sync_fields
|
|
144
154
|
end
|
|
145
155
|
|
|
146
156
|
# @see the `==` method
|
|
@@ -152,7 +162,7 @@ module DocSpring
|
|
|
152
162
|
# Calculates hash code according to all attributes.
|
|
153
163
|
# @return [Integer] Hash code
|
|
154
164
|
def hash
|
|
155
|
-
[cache_id, document_url, document_base64, filename, reimport_fields].hash
|
|
165
|
+
[cache_id, document_url, document_base64, filename, reimport_fields, sync_fields].hash
|
|
156
166
|
end
|
|
157
167
|
|
|
158
168
|
# Builds the object from hash
|