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.
Files changed (505) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +361 -150
  3. data/.openapi-generator/VERSION +1 -1
  4. data/.rubocop.yml +1 -1
  5. data/.travis.yml +1 -1
  6. data/AGENTS.md +79 -19
  7. data/CHANGELOG.md +123 -0
  8. data/Gemfile.lock +7 -7
  9. data/README.md +60 -53
  10. data/docs/{RenameFolderData.md → AiFieldNamingLanguage.md} +2 -5
  11. data/docs/AuthenticationCheck.md +18 -0
  12. data/docs/{CreateFolderData.md → BarcodeSymbology.md} +2 -5
  13. data/docs/{CreateWebhookData.md → CheckCharacter.md} +2 -5
  14. data/docs/Client.md +890 -777
  15. data/docs/{UpdateWebhookData.md → CombinedFieldType.md} +2 -5
  16. data/docs/CombinedPdf.md +44 -0
  17. data/docs/CombinedPdfFiles.md +18 -0
  18. data/docs/CombinedPdfList.md +20 -0
  19. data/docs/CombinedPdfSource.md +26 -0
  20. data/docs/CombinedPdfSourceInput.md +88 -0
  21. data/docs/CombinedPdfSourcePdf.md +20 -0
  22. data/docs/CombinedPdfSourceType.md +15 -0
  23. data/docs/CombinedPdfState.md +15 -0
  24. data/docs/CopyTemplateRequest.md +22 -0
  25. data/docs/CreateCombinedPdfRequest.md +26 -0
  26. data/docs/CreateCustomFileFromUploadRequest.md +18 -0
  27. data/docs/CreateFolderRequest.md +20 -0
  28. data/docs/CreateSignatureRequestEventRequest.md +24 -0
  29. data/docs/CreateSignatureRequestTokenRequest.md +18 -0
  30. data/docs/CreateSubmissionBatchRequest.md +26 -0
  31. data/docs/CreateSubmissionRequest.md +36 -0
  32. data/docs/CreateTemplateRequest.md +94 -0
  33. data/docs/CreateWebhookRequest.md +38 -0
  34. data/docs/CustomFile.md +11 -3
  35. data/docs/CustomFileList.md +20 -0
  36. data/docs/CustomFileSourcePdf.md +20 -0
  37. data/docs/ErrorCode.md +15 -0
  38. data/docs/ErrorDetail.md +26 -0
  39. data/docs/ErrorInfo.md +32 -0
  40. data/docs/ErrorResponse.md +1 -3
  41. data/docs/ExpirationInterval.md +15 -0
  42. data/docs/FieldComparisonCondition.md +22 -0
  43. data/docs/FieldComparisonOperator.md +15 -0
  44. data/docs/FieldDisplayType.md +15 -0
  45. data/docs/FieldEqualsCondition.md +22 -0
  46. data/docs/FieldEqualsOperator.md +15 -0
  47. data/docs/FieldInCondition.md +22 -0
  48. data/docs/FieldOverride.md +142 -0
  49. data/docs/FieldPresenceCondition.md +20 -0
  50. data/docs/FieldPresenceOperator.md +15 -0
  51. data/docs/FieldRangeCondition.md +24 -0
  52. data/docs/FieldReimportState.md +15 -0
  53. data/docs/FieldSetupLogic.md +15 -0
  54. data/docs/FieldSetupNaming.md +15 -0
  55. data/docs/FieldSetupSource.md +15 -0
  56. data/docs/Folder.md +9 -5
  57. data/docs/FolderList.md +20 -0
  58. data/docs/GeneratedFile.md +32 -0
  59. data/docs/GeneratedFileState.md +15 -0
  60. data/docs/HtmlEngineOptions.md +36 -0
  61. data/docs/HtmlEngineOptionsInput.md +36 -0
  62. data/docs/ImageGravity.md +15 -0
  63. data/docs/ImageScaleType.md +15 -0
  64. data/docs/ModelCodeLanguage.md +15 -0
  65. data/docs/MoveFolderRequest.md +18 -0
  66. data/docs/MoveTemplateRequest.md +18 -0
  67. data/docs/NumberConditionType.md +15 -0
  68. data/docs/PageFormat.md +15 -0
  69. data/docs/PublishTemplateVersionRequest.md +20 -0
  70. data/docs/RenameFolderRequest.md +18 -0
  71. data/docs/RestoreTemplateVersionRequest.md +18 -0
  72. data/docs/ShapeType.md +15 -0
  73. data/docs/SignatureRequest.md +66 -0
  74. data/docs/SignatureRequestAuthSecondFactorType.md +15 -0
  75. data/docs/SignatureRequestAuthType.md +15 -0
  76. data/docs/SignatureRequestEvent.md +32 -0
  77. data/docs/SignatureRequestEventType.md +15 -0
  78. data/docs/SignatureRequestInput.md +46 -0
  79. data/docs/SignatureRequestMessageType.md +15 -0
  80. data/docs/SignatureRequestState.md +15 -0
  81. data/docs/SignatureRequestToken.md +30 -0
  82. data/docs/SignatureRequestTokenType.md +15 -0
  83. data/docs/StringConditionType.md +15 -0
  84. data/docs/Submission.md +41 -47
  85. data/docs/SubmissionAction.md +6 -8
  86. data/docs/SubmissionActionState.md +15 -0
  87. data/docs/SubmissionActionType.md +15 -0
  88. data/docs/SubmissionBatch.md +16 -10
  89. data/docs/SubmissionBatchState.md +15 -0
  90. data/docs/SubmissionFiles.md +22 -0
  91. data/docs/SubmissionInput.md +38 -0
  92. data/docs/SubmissionList.md +20 -0
  93. data/docs/SubmissionSource.md +15 -0
  94. data/docs/SubmissionSourcePdf.md +20 -0
  95. data/docs/SubmissionState.md +15 -0
  96. data/docs/Template.md +73 -107
  97. data/docs/TemplateActor.md +26 -0
  98. data/docs/TemplateActorType.md +15 -0
  99. data/docs/TemplateDefaults.md +56 -0
  100. data/docs/TemplateDefaultsInput.md +56 -0
  101. data/docs/TemplateDocument.md +40 -0
  102. data/docs/TemplateDocumentState.md +15 -0
  103. data/docs/TemplateFieldDependency.md +26 -0
  104. data/docs/TemplateFieldDependencyAction.md +15 -0
  105. data/docs/TemplateFieldDependencyCondition.md +24 -0
  106. data/docs/TemplateFieldDependencyConditionInput.md +93 -0
  107. data/docs/TemplateFieldDependencyInput.md +26 -0
  108. data/docs/TemplateFieldDependencyMatch.md +15 -0
  109. data/docs/TemplateFieldDependencyOperator.md +15 -0
  110. data/docs/TemplateFieldLogicStatus.md +15 -0
  111. data/docs/TemplateFormMode.md +15 -0
  112. data/docs/TemplateModelCode.md +22 -0
  113. data/docs/TemplatePageAiError.md +15 -0
  114. data/docs/TemplatePageAiNamingStatus.md +15 -0
  115. data/docs/TemplatePageFieldsStatus.md +15 -0
  116. data/docs/TemplatePageImageStatus.md +15 -0
  117. data/docs/TemplatePageProcessingStatus.md +26 -0
  118. data/docs/TemplateSourcePdf.md +24 -0
  119. data/docs/TemplateSummary.md +90 -0
  120. data/docs/TemplateSummaryList.md +20 -0
  121. data/docs/TemplateType.md +15 -0
  122. data/docs/TemplateVersion.md +24 -0
  123. data/docs/TemplateVersionType.md +15 -0
  124. data/docs/TextAlignment.md +15 -0
  125. data/docs/TextOverflow.md +15 -0
  126. data/docs/TextVerticalAlignment.md +15 -0
  127. data/docs/Typeface.md +15 -0
  128. data/docs/UpdateSignatureRequestRequest.md +34 -0
  129. data/docs/UpdateTemplateDocumentRequest.md +22 -0
  130. data/docs/UpdateTemplateRequest.md +80 -0
  131. data/docs/UpdateWebhookRequest.md +38 -0
  132. data/docs/UploadMethod.md +15 -0
  133. data/docs/UploadPresign.md +24 -0
  134. data/docs/UrlSourcePdf.md +20 -0
  135. data/docs/Webhook.md +20 -20
  136. data/docs/WebhookEventType.md +15 -0
  137. data/docs/WebhookList.md +20 -0
  138. data/docs/WebhookMode.md +15 -0
  139. data/docspring.gemspec +3 -3
  140. data/lib/docspring/api/client.rb +995 -942
  141. data/lib/docspring/api_client.rb +14 -6
  142. data/lib/docspring/api_error.rb +3 -3
  143. data/lib/docspring/api_model_base.rb +88 -0
  144. data/lib/docspring/configuration.rb +12 -7
  145. data/lib/docspring/models/ai_field_naming_language.rb +42 -0
  146. data/lib/docspring/models/authentication_check.rb +185 -0
  147. data/lib/docspring/models/barcode_symbology.rb +47 -0
  148. data/lib/docspring/models/check_character.rb +44 -0
  149. data/lib/docspring/models/combined_field_type.rb +41 -0
  150. data/lib/docspring/models/{combined_submission.rb → combined_pdf.rb} +228 -206
  151. data/lib/docspring/models/combined_pdf_files.rb +167 -0
  152. data/lib/docspring/models/combined_pdf_list.rb +200 -0
  153. data/lib/docspring/models/{update_webhook_data.rb → combined_pdf_source.rb} +107 -103
  154. data/lib/docspring/models/combined_pdf_source_input.rb +62 -0
  155. data/lib/docspring/models/combined_pdf_source_pdf.rb +212 -0
  156. data/lib/docspring/models/combined_pdf_source_type.rb +44 -0
  157. data/lib/docspring/models/combined_pdf_state.rb +44 -0
  158. data/lib/docspring/models/{copy_template_options.rb → copy_template_request.rb} +32 -87
  159. data/lib/docspring/models/{combine_pdfs_data.rb → create_combined_pdf_request.rb} +60 -123
  160. data/lib/docspring/models/{create_custom_file_data.rb → create_custom_file_from_upload_request.rb} +29 -96
  161. data/lib/docspring/models/{move_template_data.rb → create_folder_request.rb} +60 -102
  162. data/lib/docspring/models/{create_submission_data_request_event_request.rb → create_signature_request_event_request.rb} +50 -122
  163. data/lib/docspring/models/create_signature_request_token_request.rb +190 -0
  164. data/lib/docspring/models/{submission_batch_data.rb → create_submission_batch_request.rb} +53 -108
  165. data/lib/docspring/models/{create_pdf_submission_data.rb → create_submission_request.rb} +97 -149
  166. data/lib/docspring/models/create_template_request.rb +601 -0
  167. data/lib/docspring/models/create_webhook_request.rb +368 -0
  168. data/lib/docspring/models/custom_file.rb +132 -95
  169. data/lib/docspring/models/custom_file_list.rb +200 -0
  170. data/lib/docspring/models/custom_file_source_pdf.rb +212 -0
  171. data/lib/docspring/models/error_code.rb +60 -0
  172. data/lib/docspring/models/error_detail.rb +242 -0
  173. data/lib/docspring/models/error_info.rb +316 -0
  174. data/lib/docspring/models/error_response.rb +28 -138
  175. data/lib/docspring/models/expiration_interval.rb +42 -0
  176. data/lib/docspring/models/field_comparison_condition.rb +247 -0
  177. data/lib/docspring/models/field_comparison_operator.rb +43 -0
  178. data/lib/docspring/models/field_display_type.rb +45 -0
  179. data/lib/docspring/models/field_equals_condition.rb +247 -0
  180. data/lib/docspring/models/field_equals_operator.rb +41 -0
  181. data/lib/docspring/models/{create_folder_data.rb → field_in_condition.rb} +101 -103
  182. data/lib/docspring/models/field_override.rb +829 -0
  183. data/lib/docspring/models/field_presence_condition.rb +234 -0
  184. data/lib/docspring/models/field_presence_operator.rb +41 -0
  185. data/lib/docspring/models/field_range_condition.rb +234 -0
  186. data/lib/docspring/models/field_reimport_state.rb +43 -0
  187. data/lib/docspring/models/field_setup_logic.rb +41 -0
  188. data/lib/docspring/models/field_setup_naming.rb +41 -0
  189. data/lib/docspring/models/field_setup_source.rb +42 -0
  190. data/lib/docspring/models/folder.rb +134 -93
  191. data/lib/docspring/models/folder_list.rb +200 -0
  192. data/lib/docspring/models/generated_file.rb +326 -0
  193. data/lib/docspring/models/generated_file_state.rb +42 -0
  194. data/lib/docspring/models/html_engine_options.rb +416 -0
  195. data/lib/docspring/models/html_engine_options_input.rb +280 -0
  196. data/lib/docspring/models/image_gravity.rb +48 -0
  197. data/lib/docspring/models/image_scale_type.rb +42 -0
  198. data/lib/docspring/models/model_code_language.rb +48 -0
  199. data/lib/docspring/models/{move_folder_data.rb → move_folder_request.rb} +31 -87
  200. data/lib/docspring/models/move_template_request.rb +171 -0
  201. data/lib/docspring/models/number_condition_type.rb +45 -0
  202. data/lib/docspring/models/page_format.rb +52 -0
  203. data/lib/docspring/models/{publish_version_data.rb → publish_template_version_request.rb} +64 -99
  204. data/lib/docspring/models/{rename_folder_data.rb → rename_folder_request.rb} +29 -87
  205. data/lib/docspring/models/{restore_version_data.rb → restore_template_version_request.rb} +29 -87
  206. data/lib/docspring/models/shape_type.rb +45 -0
  207. data/lib/docspring/models/{submission_data_request_show.rb → signature_request.rb} +240 -171
  208. data/lib/docspring/models/signature_request_auth_second_factor_type.rb +45 -0
  209. data/lib/docspring/models/signature_request_auth_type.rb +46 -0
  210. data/lib/docspring/models/{submission_data_request_event.rb → signature_request_event.rb} +137 -122
  211. data/lib/docspring/models/signature_request_event_type.rb +45 -0
  212. data/lib/docspring/models/{update_submission_data_request_data.rb → signature_request_input.rb} +156 -173
  213. data/lib/docspring/models/signature_request_message_type.rb +48 -0
  214. data/lib/docspring/models/signature_request_state.rb +42 -0
  215. data/lib/docspring/models/signature_request_token.rb +369 -0
  216. data/lib/docspring/models/signature_request_token_type.rb +41 -0
  217. data/lib/docspring/models/string_condition_type.rb +44 -0
  218. data/lib/docspring/models/submission.rb +374 -339
  219. data/lib/docspring/models/submission_action.rb +64 -136
  220. data/lib/docspring/models/submission_action_state.rb +43 -0
  221. data/lib/docspring/models/submission_action_type.rb +46 -0
  222. data/lib/docspring/models/submission_batch.rb +157 -112
  223. data/lib/docspring/models/submission_batch_state.rb +42 -0
  224. data/lib/docspring/models/submission_files.rb +188 -0
  225. data/lib/docspring/models/submission_input.rb +274 -0
  226. data/lib/docspring/models/submission_list.rb +200 -0
  227. data/lib/docspring/models/submission_source.rb +43 -0
  228. data/lib/docspring/models/submission_source_pdf.rb +212 -0
  229. data/lib/docspring/models/submission_state.rb +52 -0
  230. data/lib/docspring/models/template.rb +485 -766
  231. data/lib/docspring/models/{add_fields_data.rb → template_actor.rb} +119 -105
  232. data/lib/docspring/models/template_actor_type.rb +42 -0
  233. data/lib/docspring/models/template_defaults.rb +395 -0
  234. data/lib/docspring/models/template_defaults_input.rb +395 -0
  235. data/lib/docspring/models/template_document.rb +396 -0
  236. data/lib/docspring/models/template_document_state.rb +44 -0
  237. data/lib/docspring/models/{success_error_response.rb → template_field_dependency.rb} +122 -114
  238. data/lib/docspring/models/template_field_dependency_action.rb +42 -0
  239. data/lib/docspring/models/{create_pdf_template.rb → template_field_dependency_condition.rb} +116 -103
  240. data/lib/docspring/models/template_field_dependency_condition_input.rb +67 -0
  241. data/lib/docspring/models/template_field_dependency_input.rb +285 -0
  242. data/lib/docspring/models/template_field_dependency_match.rb +41 -0
  243. data/lib/docspring/models/template_field_dependency_operator.rb +49 -0
  244. data/lib/docspring/models/template_field_logic_status.rb +44 -0
  245. data/lib/docspring/models/template_form_mode.rb +42 -0
  246. data/lib/docspring/models/{template_model_code_response.rb → template_model_code.rb} +37 -96
  247. data/lib/docspring/models/template_page_ai_error.rb +43 -0
  248. data/lib/docspring/models/template_page_ai_naming_status.rb +41 -0
  249. data/lib/docspring/models/template_page_fields_status.rb +44 -0
  250. data/lib/docspring/models/template_page_image_status.rb +41 -0
  251. data/lib/docspring/models/template_page_processing_status.rb +275 -0
  252. data/lib/docspring/models/{create_webhook_data.rb → template_source_pdf.rb} +92 -103
  253. data/lib/docspring/models/{template_preview.rb → template_summary.rb} +436 -589
  254. data/lib/docspring/models/template_summary_list.rb +200 -0
  255. data/lib/docspring/models/template_type.rb +41 -0
  256. data/lib/docspring/models/template_version.rb +238 -0
  257. data/lib/docspring/models/template_version_type.rb +42 -0
  258. data/lib/docspring/models/text_alignment.rb +43 -0
  259. data/lib/docspring/models/text_overflow.rb +41 -0
  260. data/lib/docspring/models/text_vertical_alignment.rb +42 -0
  261. data/lib/docspring/models/typeface.rb +56 -0
  262. data/lib/docspring/models/{create_submission_data_request_data.rb → update_signature_request_request.rb} +72 -196
  263. data/lib/docspring/models/update_template_document_request.rb +205 -0
  264. data/lib/docspring/models/update_template_request.rb +514 -0
  265. data/lib/docspring/models/update_webhook_request.rb +344 -0
  266. data/lib/docspring/models/upload_method.rb +40 -0
  267. data/lib/docspring/models/{upload_presign_response.rb → upload_presign.rb} +93 -140
  268. data/lib/docspring/models/url_source_pdf.rb +212 -0
  269. data/lib/docspring/models/webhook.rb +97 -107
  270. data/lib/docspring/models/webhook_event_type.rb +64 -0
  271. data/lib/docspring/models/webhook_list.rb +200 -0
  272. data/lib/docspring/models/webhook_mode.rb +41 -0
  273. data/lib/docspring/request_schemas.json +3187 -0
  274. data/lib/docspring/request_validator.rb +396 -0
  275. data/lib/docspring/version.rb +4 -4
  276. data/lib/docspring.rb +125 -53
  277. data/spec/api/client_spec.rb +304 -277
  278. data/spec/models/ai_field_naming_language_spec.rb +30 -0
  279. data/spec/models/authentication_check_spec.rb +36 -0
  280. data/spec/models/barcode_symbology_spec.rb +30 -0
  281. data/spec/models/check_character_spec.rb +30 -0
  282. data/spec/models/combined_field_type_spec.rb +30 -0
  283. data/spec/models/combined_pdf_files_spec.rb +36 -0
  284. data/spec/models/combined_pdf_list_spec.rb +42 -0
  285. data/spec/models/combined_pdf_source_input_spec.rb +44 -0
  286. data/spec/models/combined_pdf_source_pdf_spec.rb +42 -0
  287. data/spec/models/{submission_data_request_token_spec.rb → combined_pdf_source_spec.rb} +18 -12
  288. data/spec/models/combined_pdf_source_type_spec.rb +30 -0
  289. data/spec/models/{combined_submission_spec.rb → combined_pdf_spec.rb} +20 -24
  290. data/spec/models/combined_pdf_state_spec.rb +30 -0
  291. data/spec/models/{copy_template_options_spec.rb → copy_template_request_spec.rb} +9 -9
  292. data/spec/models/{combine_pdfs_data_spec.rb → create_combined_pdf_request_spec.rb} +12 -18
  293. data/spec/models/{create_custom_file_data_spec.rb → create_custom_file_from_upload_request_spec.rb} +9 -9
  294. data/spec/models/{move_template_data_spec.rb → create_folder_request_spec.rb} +11 -11
  295. data/spec/models/{list_submissions_response_spec.rb → create_signature_request_event_request_spec.rb} +18 -12
  296. data/spec/models/create_signature_request_token_request_spec.rb +36 -0
  297. data/spec/models/{submission_batch_data_spec.rb → create_submission_batch_request_spec.rb} +13 -13
  298. data/spec/models/{create_pdf_submission_data_spec.rb → create_submission_request_spec.rb} +24 -18
  299. data/spec/models/{template_preview_spec.rb → create_template_request_spec.rb} +40 -118
  300. data/spec/models/create_webhook_request_spec.rb +96 -0
  301. data/spec/models/custom_file_list_spec.rb +42 -0
  302. data/spec/models/custom_file_source_pdf_spec.rb +42 -0
  303. data/spec/models/custom_file_spec.rb +29 -5
  304. data/spec/models/error_code_spec.rb +30 -0
  305. data/spec/models/{create_submission_response_spec.rb → error_detail_spec.rb} +14 -18
  306. data/spec/models/{batch_generate_pdfs201_response_spec.rb → error_info_spec.rb} +27 -19
  307. data/spec/models/error_response_spec.rb +4 -14
  308. data/spec/models/expiration_interval_spec.rb +30 -0
  309. data/spec/models/field_comparison_condition_spec.rb +48 -0
  310. data/spec/models/field_comparison_operator_spec.rb +30 -0
  311. data/spec/models/field_display_type_spec.rb +30 -0
  312. data/spec/models/field_equals_condition_spec.rb +48 -0
  313. data/spec/models/field_equals_operator_spec.rb +30 -0
  314. data/spec/models/field_in_condition_spec.rb +48 -0
  315. data/spec/models/field_override_spec.rb +408 -0
  316. data/spec/models/field_presence_condition_spec.rb +42 -0
  317. data/spec/models/field_presence_operator_spec.rb +30 -0
  318. data/spec/models/field_range_condition_spec.rb +54 -0
  319. data/spec/models/field_reimport_state_spec.rb +30 -0
  320. data/spec/models/field_setup_logic_spec.rb +30 -0
  321. data/spec/models/field_setup_naming_spec.rb +30 -0
  322. data/spec/models/field_setup_source_spec.rb +30 -0
  323. data/spec/models/folder_list_spec.rb +42 -0
  324. data/spec/models/folder_spec.rb +16 -4
  325. data/spec/models/generated_file_spec.rb +78 -0
  326. data/spec/models/generated_file_state_spec.rb +30 -0
  327. data/spec/models/html_engine_options_input_spec.rb +90 -0
  328. data/spec/models/html_engine_options_spec.rb +90 -0
  329. data/spec/models/image_gravity_spec.rb +30 -0
  330. data/spec/models/image_scale_type_spec.rb +30 -0
  331. data/spec/models/model_code_language_spec.rb +30 -0
  332. data/spec/models/move_folder_request_spec.rb +36 -0
  333. data/spec/models/move_template_request_spec.rb +36 -0
  334. data/spec/models/number_condition_type_spec.rb +30 -0
  335. data/spec/models/page_format_spec.rb +30 -0
  336. data/spec/models/{publish_version_data_spec.rb → publish_template_version_request_spec.rb} +11 -11
  337. data/spec/models/{rename_folder_data_spec.rb → rename_folder_request_spec.rb} +9 -9
  338. data/spec/models/restore_template_version_request_spec.rb +36 -0
  339. data/spec/models/shape_type_spec.rb +30 -0
  340. data/spec/models/signature_request_auth_second_factor_type_spec.rb +30 -0
  341. data/spec/models/signature_request_auth_type_spec.rb +30 -0
  342. data/spec/models/{submission_data_request_event_spec.rb → signature_request_event_spec.rb} +16 -18
  343. data/spec/models/signature_request_event_type_spec.rb +30 -0
  344. data/spec/models/{create_submission_data_request_data_spec.rb → signature_request_input_spec.rb} +28 -30
  345. data/spec/models/signature_request_message_type_spec.rb +30 -0
  346. data/spec/models/{submission_data_request_show_spec.rb → signature_request_spec.rb} +31 -31
  347. data/spec/models/signature_request_state_spec.rb +30 -0
  348. data/spec/models/signature_request_token_spec.rb +72 -0
  349. data/spec/models/signature_request_token_type_spec.rb +30 -0
  350. data/spec/models/string_condition_type_spec.rb +30 -0
  351. data/spec/models/submission_action_spec.rb +4 -22
  352. data/spec/models/submission_action_state_spec.rb +30 -0
  353. data/spec/models/submission_action_type_spec.rb +30 -0
  354. data/spec/models/submission_batch_spec.rb +27 -13
  355. data/spec/models/submission_batch_state_spec.rb +30 -0
  356. data/spec/models/submission_files_spec.rb +48 -0
  357. data/spec/models/submission_input_spec.rb +96 -0
  358. data/spec/models/submission_list_spec.rb +42 -0
  359. data/spec/models/submission_source_pdf_spec.rb +42 -0
  360. data/spec/models/submission_source_spec.rb +30 -0
  361. data/spec/models/submission_spec.rb +26 -56
  362. data/spec/models/submission_state_spec.rb +30 -0
  363. data/spec/models/template_actor_spec.rb +60 -0
  364. data/spec/models/template_actor_type_spec.rb +30 -0
  365. data/spec/models/{submission_data_request_spec.rb → template_defaults_input_spec.rb} +29 -53
  366. data/spec/models/template_defaults_spec.rb +150 -0
  367. data/spec/models/{json_schema_spec.rb → template_document_spec.rb} +21 -21
  368. data/spec/models/template_document_state_spec.rb +30 -0
  369. data/spec/models/template_field_dependency_action_spec.rb +30 -0
  370. data/spec/models/template_field_dependency_condition_input_spec.rb +44 -0
  371. data/spec/models/template_field_dependency_condition_spec.rb +54 -0
  372. data/spec/models/template_field_dependency_input_spec.rb +60 -0
  373. data/spec/models/template_field_dependency_match_spec.rb +30 -0
  374. data/spec/models/template_field_dependency_operator_spec.rb +30 -0
  375. data/spec/models/template_field_dependency_spec.rb +60 -0
  376. data/spec/models/template_field_logic_status_spec.rb +30 -0
  377. data/spec/models/template_form_mode_spec.rb +30 -0
  378. data/spec/models/{template_model_code_response_spec.rb → template_model_code_spec.rb} +9 -13
  379. data/spec/models/template_page_ai_error_spec.rb +30 -0
  380. data/spec/models/template_page_ai_naming_status_spec.rb +30 -0
  381. data/spec/models/template_page_fields_status_spec.rb +30 -0
  382. data/spec/models/template_page_image_status_spec.rb +30 -0
  383. data/spec/models/template_page_processing_status_spec.rb +60 -0
  384. data/spec/models/template_source_pdf_spec.rb +54 -0
  385. data/spec/models/template_spec.rb +40 -154
  386. data/spec/models/template_summary_list_spec.rb +42 -0
  387. data/spec/models/template_summary_spec.rb +252 -0
  388. data/spec/models/template_type_spec.rb +30 -0
  389. data/spec/models/template_version_spec.rb +54 -0
  390. data/spec/models/template_version_type_spec.rb +30 -0
  391. data/spec/models/text_alignment_spec.rb +30 -0
  392. data/spec/models/text_overflow_spec.rb +30 -0
  393. data/spec/models/text_vertical_alignment_spec.rb +30 -0
  394. data/spec/models/typeface_spec.rb +30 -0
  395. data/spec/models/{submission_batch_with_submissions_spec.rb → update_signature_request_request_spec.rb} +18 -22
  396. data/spec/models/update_template_document_request_spec.rb +48 -0
  397. data/spec/models/{submission_preview_spec.rb → update_template_request_spec.rb} +81 -41
  398. data/spec/models/update_webhook_request_spec.rb +96 -0
  399. data/spec/models/upload_method_spec.rb +30 -0
  400. data/spec/models/{upload_presign_response_spec.rb → upload_presign_spec.rb} +13 -17
  401. data/spec/models/url_source_pdf_spec.rb +42 -0
  402. data/spec/models/webhook_event_type_spec.rb +30 -0
  403. data/spec/models/webhook_list_spec.rb +42 -0
  404. data/spec/models/webhook_mode_spec.rb +30 -0
  405. data/spec/models/webhook_spec.rb +4 -8
  406. data/spec/spec_helper.rb +3 -3
  407. metadata +485 -202
  408. data/docs/AddFieldsData.md +0 -18
  409. data/docs/BatchGeneratePdfs201Response.md +0 -28
  410. data/docs/CombinePdfsData.md +0 -28
  411. data/docs/CombinedSubmission.md +0 -44
  412. data/docs/CombinedSubmissionAction.md +0 -30
  413. data/docs/CopyTemplateOptions.md +0 -22
  414. data/docs/CreateCombinedSubmissionResponse.md +0 -26
  415. data/docs/CreateCustomFileData.md +0 -18
  416. data/docs/CreateCustomFileResponse.md +0 -24
  417. data/docs/CreateHtmlTemplate.md +0 -18
  418. data/docs/CreatePdfSubmissionData.md +0 -34
  419. data/docs/CreatePdfTemplate.md +0 -18
  420. data/docs/CreateSubmissionDataRequestData.md +0 -44
  421. data/docs/CreateSubmissionDataRequestEventRequest.md +0 -24
  422. data/docs/CreateSubmissionDataRequestEventResponse.md +0 -24
  423. data/docs/CreateSubmissionDataRequestResponse.md +0 -24
  424. data/docs/CreateSubmissionDataRequestTokenResponse.md +0 -24
  425. data/docs/CreateSubmissionResponse.md +0 -26
  426. data/docs/ErrorOrMultipleErrorsResponse.md +0 -22
  427. data/docs/ForbiddenErrorResponse.md +0 -22
  428. data/docs/JsonSchema.md +0 -40
  429. data/docs/ListSubmissionsResponse.md +0 -22
  430. data/docs/MoveFolderData.md +0 -18
  431. data/docs/MoveTemplateData.md +0 -20
  432. data/docs/MultipleErrorsResponse.md +0 -20
  433. data/docs/PublishVersionData.md +0 -20
  434. data/docs/RestoreVersionData.md +0 -18
  435. data/docs/Submission422Response.md +0 -24
  436. data/docs/SubmissionBatchData.md +0 -26
  437. data/docs/SubmissionBatchWithSubmissions.md +0 -34
  438. data/docs/SubmissionDataRequest.md +0 -60
  439. data/docs/SubmissionDataRequestEvent.md +0 -30
  440. data/docs/SubmissionDataRequestShow.md +0 -62
  441. data/docs/SubmissionDataRequestToken.md +0 -24
  442. data/docs/SubmissionPreview.md +0 -64
  443. data/docs/SuccessErrorResponse.md +0 -20
  444. data/docs/SuccessMultipleErrorsResponse.md +0 -20
  445. data/docs/TemplateAddFieldsResponse.md +0 -22
  446. data/docs/TemplateDeleteResponse.md +0 -24
  447. data/docs/TemplateModelCodeResponse.md +0 -22
  448. data/docs/TemplatePreview.md +0 -116
  449. data/docs/TemplatePublishVersionResponse.md +0 -22
  450. data/docs/UpdateHtmlTemplate.md +0 -18
  451. data/docs/UpdatePdfTemplate.md +0 -18
  452. data/docs/UpdateSubmissionDataRequestData.md +0 -42
  453. data/docs/UploadPresignResponse.md +0 -24
  454. data/lib/docspring/models/batch_generate_pdfs201_response.rb +0 -352
  455. data/lib/docspring/models/combined_submission_action.rb +0 -384
  456. data/lib/docspring/models/create_combined_submission_response.rb +0 -324
  457. data/lib/docspring/models/create_custom_file_response.rb +0 -314
  458. data/lib/docspring/models/create_html_template.rb +0 -243
  459. data/lib/docspring/models/create_submission_data_request_event_response.rb +0 -314
  460. data/lib/docspring/models/create_submission_data_request_response.rb +0 -314
  461. data/lib/docspring/models/create_submission_data_request_token_response.rb +0 -314
  462. data/lib/docspring/models/create_submission_response.rb +0 -324
  463. data/lib/docspring/models/error_or_multiple_errors_response.rb +0 -290
  464. data/lib/docspring/models/forbidden_error_response.rb +0 -323
  465. data/lib/docspring/models/json_schema.rb +0 -329
  466. data/lib/docspring/models/list_submissions_response.rb +0 -283
  467. data/lib/docspring/models/multiple_errors_response.rb +0 -296
  468. data/lib/docspring/models/submission422_response.rb +0 -299
  469. data/lib/docspring/models/submission_batch_with_submissions.rb +0 -433
  470. data/lib/docspring/models/submission_data_request.rb +0 -570
  471. data/lib/docspring/models/submission_data_request_token.rb +0 -279
  472. data/lib/docspring/models/submission_preview.rb +0 -637
  473. data/lib/docspring/models/success_multiple_errors_response.rb +0 -279
  474. data/lib/docspring/models/template_add_fields_response.rb +0 -290
  475. data/lib/docspring/models/template_delete_response.rb +0 -300
  476. data/lib/docspring/models/template_publish_version_response.rb +0 -305
  477. data/lib/docspring/models/update_html_template.rb +0 -243
  478. data/lib/docspring/models/update_pdf_template.rb +0 -243
  479. data/spec/models/add_fields_data_spec.rb +0 -36
  480. data/spec/models/combined_submission_action_spec.rb +0 -84
  481. data/spec/models/create_combined_submission_response_spec.rb +0 -64
  482. data/spec/models/create_custom_file_response_spec.rb +0 -58
  483. data/spec/models/create_folder_data_spec.rb +0 -36
  484. data/spec/models/create_html_template_spec.rb +0 -36
  485. data/spec/models/create_pdf_template_spec.rb +0 -36
  486. data/spec/models/create_submission_data_request_event_request_spec.rb +0 -62
  487. data/spec/models/create_submission_data_request_event_response_spec.rb +0 -58
  488. data/spec/models/create_submission_data_request_response_spec.rb +0 -58
  489. data/spec/models/create_submission_data_request_token_response_spec.rb +0 -58
  490. data/spec/models/create_webhook_data_spec.rb +0 -36
  491. data/spec/models/error_or_multiple_errors_response_spec.rb +0 -52
  492. data/spec/models/forbidden_error_response_spec.rb +0 -56
  493. data/spec/models/move_folder_data_spec.rb +0 -36
  494. data/spec/models/multiple_errors_response_spec.rb +0 -46
  495. data/spec/models/restore_version_data_spec.rb +0 -36
  496. data/spec/models/submission422_response_spec.rb +0 -58
  497. data/spec/models/success_error_response_spec.rb +0 -46
  498. data/spec/models/success_multiple_errors_response_spec.rb +0 -46
  499. data/spec/models/template_add_fields_response_spec.rb +0 -52
  500. data/spec/models/template_delete_response_spec.rb +0 -58
  501. data/spec/models/template_publish_version_response_spec.rb +0 -52
  502. data/spec/models/update_html_template_spec.rb +0 -36
  503. data/spec/models/update_pdf_template_spec.rb +0 -36
  504. data/spec/models/update_submission_data_request_data_spec.rb +0 -116
  505. data/spec/models/update_webhook_data_spec.rb +0 -36
@@ -0,0 +1,829 @@
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
+ # Changes to one field's settings for this submission only. Settings left out keep the template's.
18
+ class FieldOverride < ApiModelBase
19
+ # Print the field's `default` (a fixed value, or a formula for a number field) on the PDF instead of a value from `data`.
20
+ attr_accessor :static
21
+
22
+ # Keep this field fillable in the PDF instead of flattening it to text. The submission's `editable` overrides it.
23
+ attr_accessor :editable
24
+
25
+ # The value used when `data` has none for the field.
26
+ attr_accessor :default
27
+
28
+ # The field's label on the signing form.
29
+ attr_accessor :title
30
+
31
+ # Whether `data` must have a value for the field.
32
+ attr_accessor :required
33
+
34
+ # The values the field can take, separated by commas, such as `Yes,No`. Null allows any value.
35
+ attr_accessor :option_list
36
+
37
+ # The names of the fields a combined field joins, separated by commas.
38
+ attr_accessor :combined_field_names
39
+
40
+ # How a combined field joins its fields' values.
41
+ attr_accessor :combined_field_type
42
+
43
+ # The text between the values of a combined field, such as `, `.
44
+ attr_accessor :combined_field_separator
45
+
46
+ # The text a combined field prints, with `$0`, `$1` and so on for its fields' values, such as `$0, $1`.
47
+ attr_accessor :combined_field_format
48
+
49
+ # Whether a number field takes only whole numbers.
50
+ attr_accessor :integer
51
+
52
+ # Whether a date field takes a date and time (RFC 3339) rather than a date (YYYY-MM-DD).
53
+ attr_accessor :include_time
54
+
55
+ # Let the person draw their signature or initials on the signing form.
56
+ attr_accessor :signature_allow_draw
57
+
58
+ # Let the person type their signature or initials on the signing form.
59
+ attr_accessor :signature_allow_type
60
+
61
+ # The kind of barcode a field with display_type `barcode` prints.
62
+ attr_accessor :barcode_symbology
63
+
64
+ # Leave the field off the PDF. Its value is still in the data, and combined fields can use it.
65
+ attr_accessor :hidden
66
+
67
+ # The distance from the left edge of the page, in the template editor's page units.
68
+ attr_accessor :x
69
+
70
+ # The distance from the top of the page, in the template editor's page units.
71
+ attr_accessor :y
72
+
73
+ # The field's width, in the template editor's page units.
74
+ attr_accessor :width
75
+
76
+ # The field's height, in the template editor's page units.
77
+ attr_accessor :height
78
+
79
+ # The field's rotation in degrees, clockwise.
80
+ attr_accessor :rotation
81
+
82
+ # How the field's value is drawn on the PDF.
83
+ attr_accessor :display_type
84
+
85
+ # The field's opacity, from 0 (invisible) to 1 (solid).
86
+ attr_accessor :opacity
87
+
88
+ # How a date field's value is printed, as a strftime format such as `%m/%d/%Y`. Null uses the template's date format.
89
+ attr_accessor :date_time_format
90
+
91
+ # The font of the field's text. Null uses the template's default.
92
+ attr_accessor :typeface
93
+
94
+ # The font size in points, a whole number. Null uses the template's default.
95
+ attr_accessor :font_size
96
+
97
+ # Extra space between characters, in points (0 to 50).
98
+ attr_accessor :character_spacing
99
+
100
+ # Print the text in bold.
101
+ attr_accessor :bold
102
+
103
+ # Print the text in capitals.
104
+ attr_accessor :uppercase
105
+
106
+ # Strike through the text.
107
+ attr_accessor :strikethrough
108
+
109
+ # Keep the spaces at the start of the text and of each line, so you can line text up with spaces.
110
+ attr_accessor :keep_leading_spaces
111
+
112
+ # What happens to text that doesn't fit in the field.
113
+ attr_accessor :overflow
114
+
115
+ # Wrap the text over several lines when it doesn't fit on one.
116
+ attr_accessor :multiline
117
+
118
+ # The number of lines in a multiline field, for a PDF with ruled lines. Null for no fixed number of lines.
119
+ attr_accessor :multiline_lines
120
+
121
+ # The most characters the field takes. Null for no limit.
122
+ attr_accessor :max_length
123
+
124
+ # The text color, as 6 hex digits without `#`, such as `444444`. Null uses the template's default.
125
+ attr_accessor :color
126
+
127
+ # The field's background color, as 6 hex digits without `#`. Null for none.
128
+ attr_accessor :background_color
129
+
130
+ # How text is aligned in its field. `justify` lines up both edges of every line of multiline text except the last of each paragraph.
131
+ attr_accessor :alignment
132
+
133
+ # How text is aligned vertically in its field.
134
+ attr_accessor :v_alignment
135
+
136
+ # Print one character in each of the field's equally spaced boxes (combs).
137
+ attr_accessor :comb
138
+
139
+ # The number of boxes in a comb field.
140
+ attr_accessor :comb_number_of_cells
141
+
142
+ # The character of the value that the first box starts from, for a value split over several comb fields (such as the parts of a Social Security number).
143
+ attr_accessor :comb_value_offset
144
+
145
+ # The shape a field with display_type `shape` draws.
146
+ attr_accessor :shape_type
147
+
148
+ # The number of sides of a `polygon` shape.
149
+ attr_accessor :shape_sides
150
+
151
+ # The width of a shape's border, in points, a whole number.
152
+ attr_accessor :shape_border_width
153
+
154
+ # The color of a shape's border, as 6 hex digits without `#`.
155
+ attr_accessor :shape_border_color
156
+
157
+ # The color a shape is filled with, as 6 hex digits without `#`. Null for no fill.
158
+ attr_accessor :shape_fill_color
159
+
160
+ # The character that a ticked check box prints.
161
+ attr_accessor :check_character
162
+
163
+ # The color of the check mark, as 6 hex digits without `#`. Null uses the template's default.
164
+ attr_accessor :check_color
165
+
166
+ # The color of a QR code, as 6 hex digits without `#`. Null for black.
167
+ attr_accessor :qrcode_color
168
+
169
+ # What a boolean field with display_type `text` prints for `true`.
170
+ attr_accessor :true_text
171
+
172
+ # What a boolean field with display_type `text` prints for `false`.
173
+ attr_accessor :false_text
174
+
175
+ # The value a check mark or shape is drawn for: it's drawn when the field's value matches, as `string_condition_type` or `number_condition_type` says.
176
+ attr_accessor :condition
177
+
178
+ # How a string field's value is compared with `condition`.
179
+ attr_accessor :string_condition_type
180
+
181
+ # How a number field's value is compared with `condition`, or with `number_condition_range_min` and `number_condition_range_max` for `range`.
182
+ attr_accessor :number_condition_type
183
+
184
+ # The lower end of a `range` condition.
185
+ attr_accessor :number_condition_range_min
186
+
187
+ # The upper end of a `range` condition.
188
+ attr_accessor :number_condition_range_max
189
+
190
+ # Leave the lower end itself out of a `range` condition.
191
+ attr_accessor :number_condition_range_exclusive_min
192
+
193
+ # Leave the upper end itself out of a `range` condition.
194
+ attr_accessor :number_condition_range_exclusive_max
195
+
196
+ # Draw a boolean field's check mark or shape for `false` instead of `true`.
197
+ attr_accessor :invert_boolean_condition
198
+
199
+ # The number of decimal places a number field prints. Null prints the value as it was sent.
200
+ attr_accessor :decimal_places
201
+
202
+ # How an image is resized to its field.
203
+ attr_accessor :image_scale_type
204
+
205
+ # Where an image sits in its field when it doesn't fill it, or which part is kept when it's cropped.
206
+ attr_accessor :image_gravity
207
+
208
+ class EnumAttributeValidator
209
+ attr_reader :datatype
210
+ attr_reader :allowable_values
211
+
212
+ def initialize(datatype, allowable_values)
213
+ @allowable_values = allowable_values.map do |value|
214
+ case datatype.to_s
215
+ when /Integer/i
216
+ value.to_i
217
+ when /Float/i
218
+ value.to_f
219
+ else
220
+ value
221
+ end
222
+ end
223
+ end
224
+
225
+ def valid?(value)
226
+ !value || allowable_values.include?(value)
227
+ end
228
+ end
229
+
230
+ # Attribute mapping from ruby-style variable name to JSON key.
231
+ def self.attribute_map
232
+ {
233
+ :'static' => :'static',
234
+ :'editable' => :'editable',
235
+ :'default' => :'default',
236
+ :'title' => :'title',
237
+ :'required' => :'required',
238
+ :'option_list' => :'option_list',
239
+ :'combined_field_names' => :'combined_field_names',
240
+ :'combined_field_type' => :'combined_field_type',
241
+ :'combined_field_separator' => :'combined_field_separator',
242
+ :'combined_field_format' => :'combined_field_format',
243
+ :'integer' => :'integer',
244
+ :'include_time' => :'include_time',
245
+ :'signature_allow_draw' => :'signature_allow_draw',
246
+ :'signature_allow_type' => :'signature_allow_type',
247
+ :'barcode_symbology' => :'barcode_symbology',
248
+ :'hidden' => :'hidden',
249
+ :'x' => :'x',
250
+ :'y' => :'y',
251
+ :'width' => :'width',
252
+ :'height' => :'height',
253
+ :'rotation' => :'rotation',
254
+ :'display_type' => :'display_type',
255
+ :'opacity' => :'opacity',
256
+ :'date_time_format' => :'date_time_format',
257
+ :'typeface' => :'typeface',
258
+ :'font_size' => :'font_size',
259
+ :'character_spacing' => :'character_spacing',
260
+ :'bold' => :'bold',
261
+ :'uppercase' => :'uppercase',
262
+ :'strikethrough' => :'strikethrough',
263
+ :'keep_leading_spaces' => :'keep_leading_spaces',
264
+ :'overflow' => :'overflow',
265
+ :'multiline' => :'multiline',
266
+ :'multiline_lines' => :'multiline_lines',
267
+ :'max_length' => :'max_length',
268
+ :'color' => :'color',
269
+ :'background_color' => :'background_color',
270
+ :'alignment' => :'alignment',
271
+ :'v_alignment' => :'v_alignment',
272
+ :'comb' => :'comb',
273
+ :'comb_number_of_cells' => :'comb_number_of_cells',
274
+ :'comb_value_offset' => :'comb_value_offset',
275
+ :'shape_type' => :'shape_type',
276
+ :'shape_sides' => :'shape_sides',
277
+ :'shape_border_width' => :'shape_border_width',
278
+ :'shape_border_color' => :'shape_border_color',
279
+ :'shape_fill_color' => :'shape_fill_color',
280
+ :'check_character' => :'check_character',
281
+ :'check_color' => :'check_color',
282
+ :'qrcode_color' => :'qrcode_color',
283
+ :'true_text' => :'true_text',
284
+ :'false_text' => :'false_text',
285
+ :'condition' => :'condition',
286
+ :'string_condition_type' => :'string_condition_type',
287
+ :'number_condition_type' => :'number_condition_type',
288
+ :'number_condition_range_min' => :'number_condition_range_min',
289
+ :'number_condition_range_max' => :'number_condition_range_max',
290
+ :'number_condition_range_exclusive_min' => :'number_condition_range_exclusive_min',
291
+ :'number_condition_range_exclusive_max' => :'number_condition_range_exclusive_max',
292
+ :'invert_boolean_condition' => :'invert_boolean_condition',
293
+ :'decimal_places' => :'decimal_places',
294
+ :'image_scale_type' => :'image_scale_type',
295
+ :'image_gravity' => :'image_gravity'
296
+ }
297
+ end
298
+
299
+ # Returns attribute mapping this model knows about
300
+ def self.acceptable_attribute_map
301
+ attribute_map
302
+ end
303
+
304
+ # Returns all the JSON keys this model knows about
305
+ def self.acceptable_attributes
306
+ acceptable_attribute_map.values
307
+ end
308
+
309
+ # Attribute type mapping.
310
+ def self.openapi_types
311
+ {
312
+ :'static' => :'Boolean',
313
+ :'editable' => :'Boolean',
314
+ :'default' => :'String',
315
+ :'title' => :'String',
316
+ :'required' => :'Boolean',
317
+ :'option_list' => :'String',
318
+ :'combined_field_names' => :'String',
319
+ :'combined_field_type' => :'CombinedFieldType',
320
+ :'combined_field_separator' => :'String',
321
+ :'combined_field_format' => :'String',
322
+ :'integer' => :'Boolean',
323
+ :'include_time' => :'Boolean',
324
+ :'signature_allow_draw' => :'Boolean',
325
+ :'signature_allow_type' => :'Boolean',
326
+ :'barcode_symbology' => :'BarcodeSymbology',
327
+ :'hidden' => :'Boolean',
328
+ :'x' => :'Float',
329
+ :'y' => :'Float',
330
+ :'width' => :'Float',
331
+ :'height' => :'Float',
332
+ :'rotation' => :'Float',
333
+ :'display_type' => :'FieldDisplayType',
334
+ :'opacity' => :'Float',
335
+ :'date_time_format' => :'String',
336
+ :'typeface' => :'Typeface',
337
+ :'font_size' => :'Integer',
338
+ :'character_spacing' => :'Float',
339
+ :'bold' => :'Boolean',
340
+ :'uppercase' => :'Boolean',
341
+ :'strikethrough' => :'Boolean',
342
+ :'keep_leading_spaces' => :'Boolean',
343
+ :'overflow' => :'TextOverflow',
344
+ :'multiline' => :'Boolean',
345
+ :'multiline_lines' => :'Integer',
346
+ :'max_length' => :'Integer',
347
+ :'color' => :'String',
348
+ :'background_color' => :'String',
349
+ :'alignment' => :'TextAlignment',
350
+ :'v_alignment' => :'TextVerticalAlignment',
351
+ :'comb' => :'Boolean',
352
+ :'comb_number_of_cells' => :'Integer',
353
+ :'comb_value_offset' => :'Integer',
354
+ :'shape_type' => :'ShapeType',
355
+ :'shape_sides' => :'Integer',
356
+ :'shape_border_width' => :'Integer',
357
+ :'shape_border_color' => :'String',
358
+ :'shape_fill_color' => :'String',
359
+ :'check_character' => :'CheckCharacter',
360
+ :'check_color' => :'String',
361
+ :'qrcode_color' => :'String',
362
+ :'true_text' => :'String',
363
+ :'false_text' => :'String',
364
+ :'condition' => :'String',
365
+ :'string_condition_type' => :'StringConditionType',
366
+ :'number_condition_type' => :'NumberConditionType',
367
+ :'number_condition_range_min' => :'Float',
368
+ :'number_condition_range_max' => :'Float',
369
+ :'number_condition_range_exclusive_min' => :'Boolean',
370
+ :'number_condition_range_exclusive_max' => :'Boolean',
371
+ :'invert_boolean_condition' => :'Boolean',
372
+ :'decimal_places' => :'Integer',
373
+ :'image_scale_type' => :'ImageScaleType',
374
+ :'image_gravity' => :'ImageGravity'
375
+ }
376
+ end
377
+
378
+ # List of attributes with nullable: true
379
+ def self.openapi_nullable
380
+ Set.new([
381
+ :'default',
382
+ :'option_list',
383
+ :'include_time',
384
+ :'date_time_format',
385
+ :'typeface',
386
+ :'font_size',
387
+ :'multiline_lines',
388
+ :'max_length',
389
+ :'color',
390
+ :'background_color',
391
+ :'shape_fill_color',
392
+ :'check_color',
393
+ :'qrcode_color',
394
+ :'true_text',
395
+ :'false_text',
396
+ :'condition',
397
+ :'number_condition_range_min',
398
+ :'number_condition_range_max',
399
+ :'decimal_places',
400
+ ])
401
+ end
402
+
403
+ # Returns attribute type mapping
404
+ def self.acceptable_openapi_types
405
+ openapi_types
406
+ end
407
+
408
+ # Returns the nullable attributes
409
+ def self.acceptable_openapi_nullable
410
+ openapi_nullable
411
+ end
412
+
413
+ # Initializes the object
414
+ # @param [Hash] attributes Model attributes in the form of hash
415
+ def initialize(attributes = {})
416
+ if (!attributes.is_a?(Hash))
417
+ fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::FieldOverride` initialize method"
418
+ end
419
+
420
+ # check to see if the attribute exists and convert string to symbol for hash key
421
+ acceptable_attribute_map = self.class.acceptable_attribute_map
422
+ attributes = attributes.each_with_object({}) { |(k, v), h|
423
+ if (!acceptable_attribute_map.key?(k.to_sym))
424
+ fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::FieldOverride`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
425
+ end
426
+ h[k.to_sym] = v
427
+ }
428
+
429
+ if attributes.key?(:'static')
430
+ self.static = attributes[:'static']
431
+ end
432
+
433
+ if attributes.key?(:'editable')
434
+ self.editable = attributes[:'editable']
435
+ end
436
+
437
+ if attributes.key?(:'default')
438
+ self.default = attributes[:'default']
439
+ end
440
+
441
+ if attributes.key?(:'title')
442
+ self.title = attributes[:'title']
443
+ end
444
+
445
+ if attributes.key?(:'required')
446
+ self.required = attributes[:'required']
447
+ end
448
+
449
+ if attributes.key?(:'option_list')
450
+ self.option_list = attributes[:'option_list']
451
+ end
452
+
453
+ if attributes.key?(:'combined_field_names')
454
+ self.combined_field_names = attributes[:'combined_field_names']
455
+ end
456
+
457
+ if attributes.key?(:'combined_field_type')
458
+ self.combined_field_type = attributes[:'combined_field_type']
459
+ end
460
+
461
+ if attributes.key?(:'combined_field_separator')
462
+ self.combined_field_separator = attributes[:'combined_field_separator']
463
+ end
464
+
465
+ if attributes.key?(:'combined_field_format')
466
+ self.combined_field_format = attributes[:'combined_field_format']
467
+ end
468
+
469
+ if attributes.key?(:'integer')
470
+ self.integer = attributes[:'integer']
471
+ end
472
+
473
+ if attributes.key?(:'include_time')
474
+ self.include_time = attributes[:'include_time']
475
+ end
476
+
477
+ if attributes.key?(:'signature_allow_draw')
478
+ self.signature_allow_draw = attributes[:'signature_allow_draw']
479
+ end
480
+
481
+ if attributes.key?(:'signature_allow_type')
482
+ self.signature_allow_type = attributes[:'signature_allow_type']
483
+ end
484
+
485
+ if attributes.key?(:'barcode_symbology')
486
+ self.barcode_symbology = attributes[:'barcode_symbology']
487
+ end
488
+
489
+ if attributes.key?(:'hidden')
490
+ self.hidden = attributes[:'hidden']
491
+ end
492
+
493
+ if attributes.key?(:'x')
494
+ self.x = attributes[:'x']
495
+ end
496
+
497
+ if attributes.key?(:'y')
498
+ self.y = attributes[:'y']
499
+ end
500
+
501
+ if attributes.key?(:'width')
502
+ self.width = attributes[:'width']
503
+ end
504
+
505
+ if attributes.key?(:'height')
506
+ self.height = attributes[:'height']
507
+ end
508
+
509
+ if attributes.key?(:'rotation')
510
+ self.rotation = attributes[:'rotation']
511
+ end
512
+
513
+ if attributes.key?(:'display_type')
514
+ self.display_type = attributes[:'display_type']
515
+ end
516
+
517
+ if attributes.key?(:'opacity')
518
+ self.opacity = attributes[:'opacity']
519
+ end
520
+
521
+ if attributes.key?(:'date_time_format')
522
+ self.date_time_format = attributes[:'date_time_format']
523
+ end
524
+
525
+ if attributes.key?(:'typeface')
526
+ self.typeface = attributes[:'typeface']
527
+ end
528
+
529
+ if attributes.key?(:'font_size')
530
+ self.font_size = attributes[:'font_size']
531
+ end
532
+
533
+ if attributes.key?(:'character_spacing')
534
+ self.character_spacing = attributes[:'character_spacing']
535
+ end
536
+
537
+ if attributes.key?(:'bold')
538
+ self.bold = attributes[:'bold']
539
+ end
540
+
541
+ if attributes.key?(:'uppercase')
542
+ self.uppercase = attributes[:'uppercase']
543
+ end
544
+
545
+ if attributes.key?(:'strikethrough')
546
+ self.strikethrough = attributes[:'strikethrough']
547
+ end
548
+
549
+ if attributes.key?(:'keep_leading_spaces')
550
+ self.keep_leading_spaces = attributes[:'keep_leading_spaces']
551
+ end
552
+
553
+ if attributes.key?(:'overflow')
554
+ self.overflow = attributes[:'overflow']
555
+ end
556
+
557
+ if attributes.key?(:'multiline')
558
+ self.multiline = attributes[:'multiline']
559
+ end
560
+
561
+ if attributes.key?(:'multiline_lines')
562
+ self.multiline_lines = attributes[:'multiline_lines']
563
+ end
564
+
565
+ if attributes.key?(:'max_length')
566
+ self.max_length = attributes[:'max_length']
567
+ end
568
+
569
+ if attributes.key?(:'color')
570
+ self.color = attributes[:'color']
571
+ end
572
+
573
+ if attributes.key?(:'background_color')
574
+ self.background_color = attributes[:'background_color']
575
+ end
576
+
577
+ if attributes.key?(:'alignment')
578
+ self.alignment = attributes[:'alignment']
579
+ end
580
+
581
+ if attributes.key?(:'v_alignment')
582
+ self.v_alignment = attributes[:'v_alignment']
583
+ end
584
+
585
+ if attributes.key?(:'comb')
586
+ self.comb = attributes[:'comb']
587
+ end
588
+
589
+ if attributes.key?(:'comb_number_of_cells')
590
+ self.comb_number_of_cells = attributes[:'comb_number_of_cells']
591
+ end
592
+
593
+ if attributes.key?(:'comb_value_offset')
594
+ self.comb_value_offset = attributes[:'comb_value_offset']
595
+ end
596
+
597
+ if attributes.key?(:'shape_type')
598
+ self.shape_type = attributes[:'shape_type']
599
+ end
600
+
601
+ if attributes.key?(:'shape_sides')
602
+ self.shape_sides = attributes[:'shape_sides']
603
+ end
604
+
605
+ if attributes.key?(:'shape_border_width')
606
+ self.shape_border_width = attributes[:'shape_border_width']
607
+ end
608
+
609
+ if attributes.key?(:'shape_border_color')
610
+ self.shape_border_color = attributes[:'shape_border_color']
611
+ end
612
+
613
+ if attributes.key?(:'shape_fill_color')
614
+ self.shape_fill_color = attributes[:'shape_fill_color']
615
+ end
616
+
617
+ if attributes.key?(:'check_character')
618
+ self.check_character = attributes[:'check_character']
619
+ end
620
+
621
+ if attributes.key?(:'check_color')
622
+ self.check_color = attributes[:'check_color']
623
+ end
624
+
625
+ if attributes.key?(:'qrcode_color')
626
+ self.qrcode_color = attributes[:'qrcode_color']
627
+ end
628
+
629
+ if attributes.key?(:'true_text')
630
+ self.true_text = attributes[:'true_text']
631
+ end
632
+
633
+ if attributes.key?(:'false_text')
634
+ self.false_text = attributes[:'false_text']
635
+ end
636
+
637
+ if attributes.key?(:'condition')
638
+ self.condition = attributes[:'condition']
639
+ end
640
+
641
+ if attributes.key?(:'string_condition_type')
642
+ self.string_condition_type = attributes[:'string_condition_type']
643
+ end
644
+
645
+ if attributes.key?(:'number_condition_type')
646
+ self.number_condition_type = attributes[:'number_condition_type']
647
+ end
648
+
649
+ if attributes.key?(:'number_condition_range_min')
650
+ self.number_condition_range_min = attributes[:'number_condition_range_min']
651
+ end
652
+
653
+ if attributes.key?(:'number_condition_range_max')
654
+ self.number_condition_range_max = attributes[:'number_condition_range_max']
655
+ end
656
+
657
+ if attributes.key?(:'number_condition_range_exclusive_min')
658
+ self.number_condition_range_exclusive_min = attributes[:'number_condition_range_exclusive_min']
659
+ end
660
+
661
+ if attributes.key?(:'number_condition_range_exclusive_max')
662
+ self.number_condition_range_exclusive_max = attributes[:'number_condition_range_exclusive_max']
663
+ end
664
+
665
+ if attributes.key?(:'invert_boolean_condition')
666
+ self.invert_boolean_condition = attributes[:'invert_boolean_condition']
667
+ end
668
+
669
+ if attributes.key?(:'decimal_places')
670
+ self.decimal_places = attributes[:'decimal_places']
671
+ end
672
+
673
+ if attributes.key?(:'image_scale_type')
674
+ self.image_scale_type = attributes[:'image_scale_type']
675
+ end
676
+
677
+ if attributes.key?(:'image_gravity')
678
+ self.image_gravity = attributes[:'image_gravity']
679
+ end
680
+ end
681
+
682
+ # Show invalid properties with the reasons. Usually used together with valid?
683
+ # @return Array for valid properties with the reasons
684
+ def list_invalid_properties
685
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
686
+ invalid_properties = Array.new
687
+ invalid_properties
688
+ end
689
+
690
+ # Check to see if the all the properties in the model are valid
691
+ # @return true if the model is valid
692
+ def valid?
693
+ warn '[DEPRECATED] the `valid?` method is obsolete'
694
+ true
695
+ end
696
+
697
+ # Checks equality by comparing each attribute.
698
+ # @param [Object] Object to be compared
699
+ def ==(o)
700
+ return true if self.equal?(o)
701
+ self.class == o.class &&
702
+ static == o.static &&
703
+ editable == o.editable &&
704
+ default == o.default &&
705
+ title == o.title &&
706
+ required == o.required &&
707
+ option_list == o.option_list &&
708
+ combined_field_names == o.combined_field_names &&
709
+ combined_field_type == o.combined_field_type &&
710
+ combined_field_separator == o.combined_field_separator &&
711
+ combined_field_format == o.combined_field_format &&
712
+ integer == o.integer &&
713
+ include_time == o.include_time &&
714
+ signature_allow_draw == o.signature_allow_draw &&
715
+ signature_allow_type == o.signature_allow_type &&
716
+ barcode_symbology == o.barcode_symbology &&
717
+ hidden == o.hidden &&
718
+ x == o.x &&
719
+ y == o.y &&
720
+ width == o.width &&
721
+ height == o.height &&
722
+ rotation == o.rotation &&
723
+ display_type == o.display_type &&
724
+ opacity == o.opacity &&
725
+ date_time_format == o.date_time_format &&
726
+ typeface == o.typeface &&
727
+ font_size == o.font_size &&
728
+ character_spacing == o.character_spacing &&
729
+ bold == o.bold &&
730
+ uppercase == o.uppercase &&
731
+ strikethrough == o.strikethrough &&
732
+ keep_leading_spaces == o.keep_leading_spaces &&
733
+ overflow == o.overflow &&
734
+ multiline == o.multiline &&
735
+ multiline_lines == o.multiline_lines &&
736
+ max_length == o.max_length &&
737
+ color == o.color &&
738
+ background_color == o.background_color &&
739
+ alignment == o.alignment &&
740
+ v_alignment == o.v_alignment &&
741
+ comb == o.comb &&
742
+ comb_number_of_cells == o.comb_number_of_cells &&
743
+ comb_value_offset == o.comb_value_offset &&
744
+ shape_type == o.shape_type &&
745
+ shape_sides == o.shape_sides &&
746
+ shape_border_width == o.shape_border_width &&
747
+ shape_border_color == o.shape_border_color &&
748
+ shape_fill_color == o.shape_fill_color &&
749
+ check_character == o.check_character &&
750
+ check_color == o.check_color &&
751
+ qrcode_color == o.qrcode_color &&
752
+ true_text == o.true_text &&
753
+ false_text == o.false_text &&
754
+ condition == o.condition &&
755
+ string_condition_type == o.string_condition_type &&
756
+ number_condition_type == o.number_condition_type &&
757
+ number_condition_range_min == o.number_condition_range_min &&
758
+ number_condition_range_max == o.number_condition_range_max &&
759
+ number_condition_range_exclusive_min == o.number_condition_range_exclusive_min &&
760
+ number_condition_range_exclusive_max == o.number_condition_range_exclusive_max &&
761
+ invert_boolean_condition == o.invert_boolean_condition &&
762
+ decimal_places == o.decimal_places &&
763
+ image_scale_type == o.image_scale_type &&
764
+ image_gravity == o.image_gravity
765
+ end
766
+
767
+ # @see the `==` method
768
+ # @param [Object] Object to be compared
769
+ def eql?(o)
770
+ self == o
771
+ end
772
+
773
+ # Calculates hash code according to all attributes.
774
+ # @return [Integer] Hash code
775
+ def hash
776
+ [static, editable, default, title, required, option_list, combined_field_names, combined_field_type, combined_field_separator, combined_field_format, integer, include_time, signature_allow_draw, signature_allow_type, barcode_symbology, hidden, x, y, width, height, rotation, display_type, opacity, date_time_format, typeface, font_size, character_spacing, bold, uppercase, strikethrough, keep_leading_spaces, overflow, multiline, multiline_lines, max_length, color, background_color, alignment, v_alignment, comb, comb_number_of_cells, comb_value_offset, shape_type, shape_sides, shape_border_width, shape_border_color, shape_fill_color, check_character, check_color, qrcode_color, true_text, false_text, condition, string_condition_type, number_condition_type, number_condition_range_min, number_condition_range_max, number_condition_range_exclusive_min, number_condition_range_exclusive_max, invert_boolean_condition, decimal_places, image_scale_type, image_gravity].hash
777
+ end
778
+
779
+ # Builds the object from hash
780
+ # @param [Hash] attributes Model attributes in the form of hash
781
+ # @return [Object] Returns the model itself
782
+ def self.build_from_hash(attributes)
783
+ return nil unless attributes.is_a?(Hash)
784
+ attributes = attributes.transform_keys(&:to_sym)
785
+ # include attributes inherited from allOf parents (the nearest declaration wins)
786
+ map = acceptable_attribute_map
787
+ transformed_hash = {}
788
+ acceptable_openapi_types.each_pair do |key, type|
789
+ if attributes.key?(map[key]) && attributes[map[key]].nil?
790
+ transformed_hash["#{key}"] = nil
791
+ elsif type =~ /\AArray<(.*)>/i
792
+ # check to ensure the input is an array given that the attribute
793
+ # is documented as an array but the input is not
794
+ if attributes[map[key]].is_a?(Array)
795
+ transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
796
+ end
797
+ elsif !attributes[map[key]].nil?
798
+ transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
799
+ end
800
+ end
801
+ # Responses can include enum values added after this client was released, so the enum setters
802
+ # accept any value while the model is built from a response
803
+ allocate.tap do |model|
804
+ model.instance_variable_set(:@_skip_enum_validation, true)
805
+ model.send(:initialize, transformed_hash)
806
+ model.remove_instance_variable(:@_skip_enum_validation)
807
+ end
808
+ end
809
+
810
+ # Returns the object in the form of hash
811
+ # @return [Hash] Returns the object in the form of hash
812
+ def to_hash
813
+ hash = {}
814
+ # include attributes inherited from allOf parents (the nearest declaration wins)
815
+ self.class.acceptable_attribute_map.each_pair do |attr, param|
816
+ value = self.send(attr)
817
+ if value.nil?
818
+ is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
819
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
820
+ end
821
+
822
+ hash[param] = _to_hash(value)
823
+ end
824
+ hash
825
+ end
826
+
827
+ end
828
+
829
+ end