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
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
4
|
+
#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.26.0-DOCSPRING
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -14,16 +14,41 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module DocSpring
|
|
17
|
-
|
|
17
|
+
# The version to publish.
|
|
18
|
+
class PublishTemplateVersionRequest < ApiModelBase
|
|
19
|
+
# Which part of the latest version number to increase.
|
|
20
|
+
attr_accessor :version_type
|
|
21
|
+
|
|
22
|
+
# What changed in the version, shown with it in DocSpring.
|
|
18
23
|
attr_accessor :description
|
|
19
24
|
|
|
20
|
-
|
|
25
|
+
class EnumAttributeValidator
|
|
26
|
+
attr_reader :datatype
|
|
27
|
+
attr_reader :allowable_values
|
|
28
|
+
|
|
29
|
+
def initialize(datatype, allowable_values)
|
|
30
|
+
@allowable_values = allowable_values.map do |value|
|
|
31
|
+
case datatype.to_s
|
|
32
|
+
when /Integer/i
|
|
33
|
+
value.to_i
|
|
34
|
+
when /Float/i
|
|
35
|
+
value.to_f
|
|
36
|
+
else
|
|
37
|
+
value
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def valid?(value)
|
|
43
|
+
!value || allowable_values.include?(value)
|
|
44
|
+
end
|
|
45
|
+
end
|
|
21
46
|
|
|
22
47
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
23
48
|
def self.attribute_map
|
|
24
49
|
{
|
|
25
|
-
:'
|
|
26
|
-
:'
|
|
50
|
+
:'version_type' => :'version_type',
|
|
51
|
+
:'description' => :'description'
|
|
27
52
|
}
|
|
28
53
|
end
|
|
29
54
|
|
|
@@ -40,8 +65,8 @@ module DocSpring
|
|
|
40
65
|
# Attribute type mapping.
|
|
41
66
|
def self.openapi_types
|
|
42
67
|
{
|
|
43
|
-
:'
|
|
44
|
-
:'
|
|
68
|
+
:'version_type' => :'TemplateVersionType',
|
|
69
|
+
:'description' => :'String'
|
|
45
70
|
}
|
|
46
71
|
end
|
|
47
72
|
|
|
@@ -51,31 +76,41 @@ module DocSpring
|
|
|
51
76
|
])
|
|
52
77
|
end
|
|
53
78
|
|
|
79
|
+
# Returns attribute type mapping
|
|
80
|
+
def self.acceptable_openapi_types
|
|
81
|
+
openapi_types
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Returns the nullable attributes
|
|
85
|
+
def self.acceptable_openapi_nullable
|
|
86
|
+
openapi_nullable
|
|
87
|
+
end
|
|
88
|
+
|
|
54
89
|
# Initializes the object
|
|
55
90
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
56
91
|
def initialize(attributes = {})
|
|
57
92
|
if (!attributes.is_a?(Hash))
|
|
58
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::
|
|
93
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::PublishTemplateVersionRequest` initialize method"
|
|
59
94
|
end
|
|
60
95
|
|
|
61
96
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
62
97
|
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
63
98
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
64
99
|
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
65
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::
|
|
100
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::PublishTemplateVersionRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
66
101
|
end
|
|
67
102
|
h[k.to_sym] = v
|
|
68
103
|
}
|
|
69
104
|
|
|
70
|
-
if attributes.key?(:'description')
|
|
71
|
-
self.description = attributes[:'description']
|
|
72
|
-
end
|
|
73
|
-
|
|
74
105
|
if attributes.key?(:'version_type')
|
|
75
106
|
self.version_type = attributes[:'version_type']
|
|
76
107
|
else
|
|
77
108
|
self.version_type = nil
|
|
78
109
|
end
|
|
110
|
+
|
|
111
|
+
if attributes.key?(:'description')
|
|
112
|
+
self.description = attributes[:'description']
|
|
113
|
+
end
|
|
79
114
|
end
|
|
80
115
|
|
|
81
116
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -113,8 +148,8 @@ module DocSpring
|
|
|
113
148
|
def ==(o)
|
|
114
149
|
return true if self.equal?(o)
|
|
115
150
|
self.class == o.class &&
|
|
116
|
-
|
|
117
|
-
|
|
151
|
+
version_type == o.version_type &&
|
|
152
|
+
description == o.description
|
|
118
153
|
end
|
|
119
154
|
|
|
120
155
|
# @see the `==` method
|
|
@@ -126,7 +161,7 @@ module DocSpring
|
|
|
126
161
|
# Calculates hash code according to all attributes.
|
|
127
162
|
# @return [Integer] Hash code
|
|
128
163
|
def hash
|
|
129
|
-
[
|
|
164
|
+
[version_type, description].hash
|
|
130
165
|
end
|
|
131
166
|
|
|
132
167
|
# Builds the object from hash
|
|
@@ -135,18 +170,20 @@ module DocSpring
|
|
|
135
170
|
def self.build_from_hash(attributes)
|
|
136
171
|
return nil unless attributes.is_a?(Hash)
|
|
137
172
|
attributes = attributes.transform_keys(&:to_sym)
|
|
173
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
174
|
+
map = acceptable_attribute_map
|
|
138
175
|
transformed_hash = {}
|
|
139
|
-
|
|
140
|
-
if attributes.key?(
|
|
176
|
+
acceptable_openapi_types.each_pair do |key, type|
|
|
177
|
+
if attributes.key?(map[key]) && attributes[map[key]].nil?
|
|
141
178
|
transformed_hash["#{key}"] = nil
|
|
142
179
|
elsif type =~ /\AArray<(.*)>/i
|
|
143
180
|
# check to ensure the input is an array given that the attribute
|
|
144
181
|
# is documented as an array but the input is not
|
|
145
|
-
if attributes[
|
|
146
|
-
transformed_hash["#{key}"] = attributes[
|
|
182
|
+
if attributes[map[key]].is_a?(Array)
|
|
183
|
+
transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
|
|
147
184
|
end
|
|
148
|
-
elsif !attributes[
|
|
149
|
-
transformed_hash["#{key}"] = _deserialize(type, attributes[
|
|
185
|
+
elsif !attributes[map[key]].nil?
|
|
186
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
|
|
150
187
|
end
|
|
151
188
|
end
|
|
152
189
|
# Responses can include enum values added after this client was released, so the enum setters
|
|
@@ -158,69 +195,15 @@ module DocSpring
|
|
|
158
195
|
end
|
|
159
196
|
end
|
|
160
197
|
|
|
161
|
-
# Deserializes the data based on type
|
|
162
|
-
# @param string type Data type
|
|
163
|
-
# @param string value Value to be deserialized
|
|
164
|
-
# @return [Object] Deserialized data
|
|
165
|
-
def self._deserialize(type, value)
|
|
166
|
-
case type.to_sym
|
|
167
|
-
when :Time
|
|
168
|
-
Time.parse(value)
|
|
169
|
-
when :Date
|
|
170
|
-
Date.parse(value)
|
|
171
|
-
when :String
|
|
172
|
-
value.to_s
|
|
173
|
-
when :Integer
|
|
174
|
-
value.to_i
|
|
175
|
-
when :Float
|
|
176
|
-
value.to_f
|
|
177
|
-
when :Boolean
|
|
178
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
179
|
-
true
|
|
180
|
-
else
|
|
181
|
-
false
|
|
182
|
-
end
|
|
183
|
-
when :Object
|
|
184
|
-
# generic object (usually a Hash), return directly
|
|
185
|
-
value
|
|
186
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
187
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
188
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
189
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
190
|
-
k_type = Regexp.last_match[:k_type]
|
|
191
|
-
v_type = Regexp.last_match[:v_type]
|
|
192
|
-
{}.tap do |hash|
|
|
193
|
-
value.each do |k, v|
|
|
194
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
195
|
-
end
|
|
196
|
-
end
|
|
197
|
-
else # model
|
|
198
|
-
# models (e.g. Pet) or oneOf
|
|
199
|
-
klass = DocSpring.const_get(type)
|
|
200
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
201
|
-
end
|
|
202
|
-
end
|
|
203
|
-
|
|
204
|
-
# Returns the string representation of the object
|
|
205
|
-
# @return [String] String presentation of the object
|
|
206
|
-
def to_s
|
|
207
|
-
to_hash.to_s
|
|
208
|
-
end
|
|
209
|
-
|
|
210
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
211
|
-
# @return [Hash] Returns the object in the form of hash
|
|
212
|
-
def to_body
|
|
213
|
-
to_hash
|
|
214
|
-
end
|
|
215
|
-
|
|
216
198
|
# Returns the object in the form of hash
|
|
217
199
|
# @return [Hash] Returns the object in the form of hash
|
|
218
200
|
def to_hash
|
|
219
201
|
hash = {}
|
|
220
|
-
|
|
202
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
203
|
+
self.class.acceptable_attribute_map.each_pair do |attr, param|
|
|
221
204
|
value = self.send(attr)
|
|
222
205
|
if value.nil?
|
|
223
|
-
is_nullable = self.class.
|
|
206
|
+
is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
|
|
224
207
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
225
208
|
end
|
|
226
209
|
|
|
@@ -229,24 +212,6 @@ module DocSpring
|
|
|
229
212
|
hash
|
|
230
213
|
end
|
|
231
214
|
|
|
232
|
-
# Outputs non-array value in the form of hash
|
|
233
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
234
|
-
# @param [Object] value Any valid value
|
|
235
|
-
# @return [Hash] Returns the value in the form of hash
|
|
236
|
-
def _to_hash(value)
|
|
237
|
-
if value.is_a?(Array)
|
|
238
|
-
value.compact.map { |v| _to_hash(v) }
|
|
239
|
-
elsif value.is_a?(Hash)
|
|
240
|
-
{}.tap do |hash|
|
|
241
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
242
|
-
end
|
|
243
|
-
elsif value.respond_to? :to_hash
|
|
244
|
-
value.to_hash
|
|
245
|
-
else
|
|
246
|
-
value
|
|
247
|
-
end
|
|
248
|
-
end
|
|
249
|
-
|
|
250
215
|
end
|
|
251
216
|
|
|
252
217
|
end
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
4
|
+
#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.26.0-DOCSPRING
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -14,7 +14,9 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module DocSpring
|
|
17
|
-
|
|
17
|
+
# The folder's new name.
|
|
18
|
+
class RenameFolderRequest < ApiModelBase
|
|
19
|
+
# The folder's name. It can't contain `/`, and is unique within its parent folder.
|
|
18
20
|
attr_accessor :name
|
|
19
21
|
|
|
20
22
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -47,18 +49,28 @@ module DocSpring
|
|
|
47
49
|
])
|
|
48
50
|
end
|
|
49
51
|
|
|
52
|
+
# Returns attribute type mapping
|
|
53
|
+
def self.acceptable_openapi_types
|
|
54
|
+
openapi_types
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Returns the nullable attributes
|
|
58
|
+
def self.acceptable_openapi_nullable
|
|
59
|
+
openapi_nullable
|
|
60
|
+
end
|
|
61
|
+
|
|
50
62
|
# Initializes the object
|
|
51
63
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
52
64
|
def initialize(attributes = {})
|
|
53
65
|
if (!attributes.is_a?(Hash))
|
|
54
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::
|
|
66
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::RenameFolderRequest` initialize method"
|
|
55
67
|
end
|
|
56
68
|
|
|
57
69
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
58
70
|
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
59
71
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
60
72
|
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
61
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::
|
|
73
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::RenameFolderRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
62
74
|
end
|
|
63
75
|
h[k.to_sym] = v
|
|
64
76
|
}
|
|
@@ -126,18 +138,20 @@ module DocSpring
|
|
|
126
138
|
def self.build_from_hash(attributes)
|
|
127
139
|
return nil unless attributes.is_a?(Hash)
|
|
128
140
|
attributes = attributes.transform_keys(&:to_sym)
|
|
141
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
142
|
+
map = acceptable_attribute_map
|
|
129
143
|
transformed_hash = {}
|
|
130
|
-
|
|
131
|
-
if attributes.key?(
|
|
144
|
+
acceptable_openapi_types.each_pair do |key, type|
|
|
145
|
+
if attributes.key?(map[key]) && attributes[map[key]].nil?
|
|
132
146
|
transformed_hash["#{key}"] = nil
|
|
133
147
|
elsif type =~ /\AArray<(.*)>/i
|
|
134
148
|
# check to ensure the input is an array given that the attribute
|
|
135
149
|
# is documented as an array but the input is not
|
|
136
|
-
if attributes[
|
|
137
|
-
transformed_hash["#{key}"] = attributes[
|
|
150
|
+
if attributes[map[key]].is_a?(Array)
|
|
151
|
+
transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
|
|
138
152
|
end
|
|
139
|
-
elsif !attributes[
|
|
140
|
-
transformed_hash["#{key}"] = _deserialize(type, attributes[
|
|
153
|
+
elsif !attributes[map[key]].nil?
|
|
154
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
|
|
141
155
|
end
|
|
142
156
|
end
|
|
143
157
|
# Responses can include enum values added after this client was released, so the enum setters
|
|
@@ -149,69 +163,15 @@ module DocSpring
|
|
|
149
163
|
end
|
|
150
164
|
end
|
|
151
165
|
|
|
152
|
-
# Deserializes the data based on type
|
|
153
|
-
# @param string type Data type
|
|
154
|
-
# @param string value Value to be deserialized
|
|
155
|
-
# @return [Object] Deserialized data
|
|
156
|
-
def self._deserialize(type, value)
|
|
157
|
-
case type.to_sym
|
|
158
|
-
when :Time
|
|
159
|
-
Time.parse(value)
|
|
160
|
-
when :Date
|
|
161
|
-
Date.parse(value)
|
|
162
|
-
when :String
|
|
163
|
-
value.to_s
|
|
164
|
-
when :Integer
|
|
165
|
-
value.to_i
|
|
166
|
-
when :Float
|
|
167
|
-
value.to_f
|
|
168
|
-
when :Boolean
|
|
169
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
170
|
-
true
|
|
171
|
-
else
|
|
172
|
-
false
|
|
173
|
-
end
|
|
174
|
-
when :Object
|
|
175
|
-
# generic object (usually a Hash), return directly
|
|
176
|
-
value
|
|
177
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
178
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
179
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
180
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
181
|
-
k_type = Regexp.last_match[:k_type]
|
|
182
|
-
v_type = Regexp.last_match[:v_type]
|
|
183
|
-
{}.tap do |hash|
|
|
184
|
-
value.each do |k, v|
|
|
185
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
186
|
-
end
|
|
187
|
-
end
|
|
188
|
-
else # model
|
|
189
|
-
# models (e.g. Pet) or oneOf
|
|
190
|
-
klass = DocSpring.const_get(type)
|
|
191
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
192
|
-
end
|
|
193
|
-
end
|
|
194
|
-
|
|
195
|
-
# Returns the string representation of the object
|
|
196
|
-
# @return [String] String presentation of the object
|
|
197
|
-
def to_s
|
|
198
|
-
to_hash.to_s
|
|
199
|
-
end
|
|
200
|
-
|
|
201
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
202
|
-
# @return [Hash] Returns the object in the form of hash
|
|
203
|
-
def to_body
|
|
204
|
-
to_hash
|
|
205
|
-
end
|
|
206
|
-
|
|
207
166
|
# Returns the object in the form of hash
|
|
208
167
|
# @return [Hash] Returns the object in the form of hash
|
|
209
168
|
def to_hash
|
|
210
169
|
hash = {}
|
|
211
|
-
|
|
170
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
171
|
+
self.class.acceptable_attribute_map.each_pair do |attr, param|
|
|
212
172
|
value = self.send(attr)
|
|
213
173
|
if value.nil?
|
|
214
|
-
is_nullable = self.class.
|
|
174
|
+
is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
|
|
215
175
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
216
176
|
end
|
|
217
177
|
|
|
@@ -220,24 +180,6 @@ module DocSpring
|
|
|
220
180
|
hash
|
|
221
181
|
end
|
|
222
182
|
|
|
223
|
-
# Outputs non-array value in the form of hash
|
|
224
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
225
|
-
# @param [Object] value Any valid value
|
|
226
|
-
# @return [Hash] Returns the value in the form of hash
|
|
227
|
-
def _to_hash(value)
|
|
228
|
-
if value.is_a?(Array)
|
|
229
|
-
value.compact.map { |v| _to_hash(v) }
|
|
230
|
-
elsif value.is_a?(Hash)
|
|
231
|
-
{}.tap do |hash|
|
|
232
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
233
|
-
end
|
|
234
|
-
elsif value.respond_to? :to_hash
|
|
235
|
-
value.to_hash
|
|
236
|
-
else
|
|
237
|
-
value
|
|
238
|
-
end
|
|
239
|
-
end
|
|
240
|
-
|
|
241
183
|
end
|
|
242
184
|
|
|
243
185
|
end
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#DocSpring API
|
|
3
3
|
|
|
4
|
-
#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
4
|
+
#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document: v2
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.
|
|
9
|
+
Generator version: 7.26.0-DOCSPRING
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -14,7 +14,9 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module DocSpring
|
|
17
|
-
|
|
17
|
+
# The version to restore.
|
|
18
|
+
class RestoreTemplateVersionRequest < ApiModelBase
|
|
19
|
+
# The published version to restore to the draft (`1.2.0`, or `1` for the latest 1.x.x).
|
|
18
20
|
attr_accessor :version
|
|
19
21
|
|
|
20
22
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -47,18 +49,28 @@ module DocSpring
|
|
|
47
49
|
])
|
|
48
50
|
end
|
|
49
51
|
|
|
52
|
+
# Returns attribute type mapping
|
|
53
|
+
def self.acceptable_openapi_types
|
|
54
|
+
openapi_types
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# Returns the nullable attributes
|
|
58
|
+
def self.acceptable_openapi_nullable
|
|
59
|
+
openapi_nullable
|
|
60
|
+
end
|
|
61
|
+
|
|
50
62
|
# Initializes the object
|
|
51
63
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
52
64
|
def initialize(attributes = {})
|
|
53
65
|
if (!attributes.is_a?(Hash))
|
|
54
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::
|
|
66
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::RestoreTemplateVersionRequest` initialize method"
|
|
55
67
|
end
|
|
56
68
|
|
|
57
69
|
# check to see if the attribute exists and convert string to symbol for hash key
|
|
58
70
|
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
59
71
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
60
72
|
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
61
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::
|
|
73
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::RestoreTemplateVersionRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
62
74
|
end
|
|
63
75
|
h[k.to_sym] = v
|
|
64
76
|
}
|
|
@@ -126,18 +138,20 @@ module DocSpring
|
|
|
126
138
|
def self.build_from_hash(attributes)
|
|
127
139
|
return nil unless attributes.is_a?(Hash)
|
|
128
140
|
attributes = attributes.transform_keys(&:to_sym)
|
|
141
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
142
|
+
map = acceptable_attribute_map
|
|
129
143
|
transformed_hash = {}
|
|
130
|
-
|
|
131
|
-
if attributes.key?(
|
|
144
|
+
acceptable_openapi_types.each_pair do |key, type|
|
|
145
|
+
if attributes.key?(map[key]) && attributes[map[key]].nil?
|
|
132
146
|
transformed_hash["#{key}"] = nil
|
|
133
147
|
elsif type =~ /\AArray<(.*)>/i
|
|
134
148
|
# check to ensure the input is an array given that the attribute
|
|
135
149
|
# is documented as an array but the input is not
|
|
136
|
-
if attributes[
|
|
137
|
-
transformed_hash["#{key}"] = attributes[
|
|
150
|
+
if attributes[map[key]].is_a?(Array)
|
|
151
|
+
transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
|
|
138
152
|
end
|
|
139
|
-
elsif !attributes[
|
|
140
|
-
transformed_hash["#{key}"] = _deserialize(type, attributes[
|
|
153
|
+
elsif !attributes[map[key]].nil?
|
|
154
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
|
|
141
155
|
end
|
|
142
156
|
end
|
|
143
157
|
# Responses can include enum values added after this client was released, so the enum setters
|
|
@@ -149,69 +163,15 @@ module DocSpring
|
|
|
149
163
|
end
|
|
150
164
|
end
|
|
151
165
|
|
|
152
|
-
# Deserializes the data based on type
|
|
153
|
-
# @param string type Data type
|
|
154
|
-
# @param string value Value to be deserialized
|
|
155
|
-
# @return [Object] Deserialized data
|
|
156
|
-
def self._deserialize(type, value)
|
|
157
|
-
case type.to_sym
|
|
158
|
-
when :Time
|
|
159
|
-
Time.parse(value)
|
|
160
|
-
when :Date
|
|
161
|
-
Date.parse(value)
|
|
162
|
-
when :String
|
|
163
|
-
value.to_s
|
|
164
|
-
when :Integer
|
|
165
|
-
value.to_i
|
|
166
|
-
when :Float
|
|
167
|
-
value.to_f
|
|
168
|
-
when :Boolean
|
|
169
|
-
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
170
|
-
true
|
|
171
|
-
else
|
|
172
|
-
false
|
|
173
|
-
end
|
|
174
|
-
when :Object
|
|
175
|
-
# generic object (usually a Hash), return directly
|
|
176
|
-
value
|
|
177
|
-
when /\AArray<(?<inner_type>.+)>\z/
|
|
178
|
-
inner_type = Regexp.last_match[:inner_type]
|
|
179
|
-
value.map { |v| _deserialize(inner_type, v) }
|
|
180
|
-
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
181
|
-
k_type = Regexp.last_match[:k_type]
|
|
182
|
-
v_type = Regexp.last_match[:v_type]
|
|
183
|
-
{}.tap do |hash|
|
|
184
|
-
value.each do |k, v|
|
|
185
|
-
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
186
|
-
end
|
|
187
|
-
end
|
|
188
|
-
else # model
|
|
189
|
-
# models (e.g. Pet) or oneOf
|
|
190
|
-
klass = DocSpring.const_get(type)
|
|
191
|
-
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
192
|
-
end
|
|
193
|
-
end
|
|
194
|
-
|
|
195
|
-
# Returns the string representation of the object
|
|
196
|
-
# @return [String] String presentation of the object
|
|
197
|
-
def to_s
|
|
198
|
-
to_hash.to_s
|
|
199
|
-
end
|
|
200
|
-
|
|
201
|
-
# to_body is an alias to to_hash (backward compatibility)
|
|
202
|
-
# @return [Hash] Returns the object in the form of hash
|
|
203
|
-
def to_body
|
|
204
|
-
to_hash
|
|
205
|
-
end
|
|
206
|
-
|
|
207
166
|
# Returns the object in the form of hash
|
|
208
167
|
# @return [Hash] Returns the object in the form of hash
|
|
209
168
|
def to_hash
|
|
210
169
|
hash = {}
|
|
211
|
-
|
|
170
|
+
# include attributes inherited from allOf parents (the nearest declaration wins)
|
|
171
|
+
self.class.acceptable_attribute_map.each_pair do |attr, param|
|
|
212
172
|
value = self.send(attr)
|
|
213
173
|
if value.nil?
|
|
214
|
-
is_nullable = self.class.
|
|
174
|
+
is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
|
|
215
175
|
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
216
176
|
end
|
|
217
177
|
|
|
@@ -220,24 +180,6 @@ module DocSpring
|
|
|
220
180
|
hash
|
|
221
181
|
end
|
|
222
182
|
|
|
223
|
-
# Outputs non-array value in the form of hash
|
|
224
|
-
# For object, use to_hash. Otherwise, just return the value
|
|
225
|
-
# @param [Object] value Any valid value
|
|
226
|
-
# @return [Hash] Returns the value in the form of hash
|
|
227
|
-
def _to_hash(value)
|
|
228
|
-
if value.is_a?(Array)
|
|
229
|
-
value.compact.map { |v| _to_hash(v) }
|
|
230
|
-
elsif value.is_a?(Hash)
|
|
231
|
-
{}.tap do |hash|
|
|
232
|
-
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
233
|
-
end
|
|
234
|
-
elsif value.respond_to? :to_hash
|
|
235
|
-
value.to_hash
|
|
236
|
-
else
|
|
237
|
-
value
|
|
238
|
-
end
|
|
239
|
-
end
|
|
240
|
-
|
|
241
183
|
end
|
|
242
184
|
|
|
243
185
|
end
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#DocSpring API
|
|
3
|
+
|
|
4
|
+
#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or 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
|
+
class ShapeType
|
|
18
|
+
SQUARE = "square".freeze
|
|
19
|
+
RECTANGLE = "rectangle".freeze
|
|
20
|
+
CIRCLE = "circle".freeze
|
|
21
|
+
ELLIPSE = "ellipse".freeze
|
|
22
|
+
TRIANGLE = "triangle".freeze
|
|
23
|
+
POLYGON = "polygon".freeze
|
|
24
|
+
|
|
25
|
+
def self.all_vars
|
|
26
|
+
@all_vars ||= [SQUARE, RECTANGLE, CIRCLE, ELLIPSE, TRIANGLE, POLYGON].freeze
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
# Builds the enum from string
|
|
30
|
+
# @param [String] The enum value in the form of the string
|
|
31
|
+
# @return [String] The enum value
|
|
32
|
+
def self.build_from_hash(value)
|
|
33
|
+
new.build_from_hash(value)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Builds the enum from string
|
|
37
|
+
# @param [String] The enum value in the form of the string
|
|
38
|
+
# @return [String] The enum value
|
|
39
|
+
def build_from_hash(value)
|
|
40
|
+
# Only responses are built from hashes, and a value added to the API after this client was released is kept as it
|
|
41
|
+
# is: the constants are the values this client knows
|
|
42
|
+
value
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|