pdf_generator_api_client 4.0.25

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 (451) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +519 -0
  4. data/Rakefile +10 -0
  5. data/docs/AccessibilityOption.md +15 -0
  6. data/docs/AddWatermarkRequest.md +49 -0
  7. data/docs/AssetsApi.md +77 -0
  8. data/docs/AsyncOutputParam.md +15 -0
  9. data/docs/CallbackParam.md +20 -0
  10. data/docs/Component.md +34 -0
  11. data/docs/ConversionApi.md +217 -0
  12. data/docs/ConvertHTML2PDFRequest.md +26 -0
  13. data/docs/ConvertPDF2ImageRequest.md +32 -0
  14. data/docs/ConvertURL2PDFRequest.md +26 -0
  15. data/docs/CopyTemplateRequest.md +18 -0
  16. data/docs/CreateEInvoiceRequest.md +22 -0
  17. data/docs/CreateFacturXEInvoiceRequest.md +26 -0
  18. data/docs/CreateFacturXEInvoiceRequestTemplate.md +22 -0
  19. data/docs/CreateWorkspaceRequest.md +18 -0
  20. data/docs/DataBatchInner.md +20 -0
  21. data/docs/Document.md +26 -0
  22. data/docs/DocumentsApi.md +646 -0
  23. data/docs/EInvoicesApi.md +284 -0
  24. data/docs/EncryptAndDecryptBase64.md +26 -0
  25. data/docs/EncryptAndDecryptUrl.md +26 -0
  26. data/docs/EncryptDocumentRequest.md +49 -0
  27. data/docs/ExtractFormFieldsRequest.md +49 -0
  28. data/docs/FillFormFieldsRequest.md +49 -0
  29. data/docs/FormActionDownload.md +18 -0
  30. data/docs/FormActionSend.md +18 -0
  31. data/docs/FormActionSendSendDocument.md +20 -0
  32. data/docs/FormActionSendSendDocumentHeadersInner.md +20 -0
  33. data/docs/FormActionStore.md +18 -0
  34. data/docs/FormConfiguration.md +22 -0
  35. data/docs/FormConfigurationNew.md +26 -0
  36. data/docs/FormConfigurationNewActionsInner.md +22 -0
  37. data/docs/FormFieldsBase64.md +20 -0
  38. data/docs/FormFieldsInner.md +24 -0
  39. data/docs/FormFieldsUrl.md +20 -0
  40. data/docs/FormFillBase64.md +24 -0
  41. data/docs/FormFillUrl.md +24 -0
  42. data/docs/FormatParam.md +15 -0
  43. data/docs/FormsApi.md +639 -0
  44. data/docs/GenerateDocumentAsynchronousRequest.md +32 -0
  45. data/docs/GenerateDocumentBatchAsynchronousRequest.md +30 -0
  46. data/docs/GenerateDocumentBatchRequest.md +28 -0
  47. data/docs/GenerateDocumentRequest.md +30 -0
  48. data/docs/GenerateQRCode201Response.md +20 -0
  49. data/docs/GenerateQRCode201ResponseMeta.md +20 -0
  50. data/docs/GenerateQRCodeRequest.md +26 -0
  51. data/docs/GetStatus200Response.md +28 -0
  52. data/docs/GetTemplateLibrary200Response.md +18 -0
  53. data/docs/GetTemplateVersion422Response.md +18 -0
  54. data/docs/ImportFormBase64.md +20 -0
  55. data/docs/ImportFormRequest.md +49 -0
  56. data/docs/ImportFormUrl.md +20 -0
  57. data/docs/ImportTemplateBase64.md +20 -0
  58. data/docs/ImportTemplateRequest.md +49 -0
  59. data/docs/ImportTemplateUrl.md +20 -0
  60. data/docs/ImportTemplateUrlTemplate.md +18 -0
  61. data/docs/InlineObject.md +20 -0
  62. data/docs/InlineObject1.md +18 -0
  63. data/docs/InlineObject10.md +20 -0
  64. data/docs/InlineObject10Meta.md +24 -0
  65. data/docs/InlineObject11.md +20 -0
  66. data/docs/InlineObject11Meta.md +26 -0
  67. data/docs/InlineObject12.md +20 -0
  68. data/docs/InlineObject12Meta.md +28 -0
  69. data/docs/InlineObject12MetaStats.md +20 -0
  70. data/docs/InlineObject13.md +20 -0
  71. data/docs/InlineObject14.md +18 -0
  72. data/docs/InlineObject14ResponseValue.md +46 -0
  73. data/docs/InlineObject14ResponseValueDefault.md +51 -0
  74. data/docs/InlineObject14ResponseValueValue.md +51 -0
  75. data/docs/InlineObject15.md +20 -0
  76. data/docs/InlineObject16.md +20 -0
  77. data/docs/InlineObject17.md +18 -0
  78. data/docs/InlineObject18.md +20 -0
  79. data/docs/InlineObject18Meta.md +18 -0
  80. data/docs/InlineObject19.md +18 -0
  81. data/docs/InlineObject1Response.md +18 -0
  82. data/docs/InlineObject2.md +18 -0
  83. data/docs/InlineObject20.md +18 -0
  84. data/docs/InlineObject20Response.md +18 -0
  85. data/docs/InlineObject21.md +18 -0
  86. data/docs/InlineObject22.md +18 -0
  87. data/docs/InlineObject23.md +18 -0
  88. data/docs/InlineObject24.md +18 -0
  89. data/docs/InlineObject25.md +20 -0
  90. data/docs/InlineObject26.md +18 -0
  91. data/docs/InlineObject27.md +18 -0
  92. data/docs/InlineObject3.md +18 -0
  93. data/docs/InlineObject4.md +20 -0
  94. data/docs/InlineObject5.md +20 -0
  95. data/docs/InlineObject6.md +20 -0
  96. data/docs/InlineObject7.md +18 -0
  97. data/docs/InlineObject7Response.md +18 -0
  98. data/docs/InlineObject8.md +18 -0
  99. data/docs/InlineObject9.md +20 -0
  100. data/docs/InlineObject9Meta.md +26 -0
  101. data/docs/InlineObjectMeta.md +20 -0
  102. data/docs/KeyFieldParam.md +15 -0
  103. data/docs/MakeAccessibleBase64.md +26 -0
  104. data/docs/MakeAccessibleRequest.md +49 -0
  105. data/docs/MakeAccessibleUrl.md +26 -0
  106. data/docs/MetadataParam.md +20 -0
  107. data/docs/MiscApi.md +74 -0
  108. data/docs/OpenEditorRequest.md +20 -0
  109. data/docs/OpenEditorRequestData.md +49 -0
  110. data/docs/OptimizeBase64.md +22 -0
  111. data/docs/OptimizeDocumentRequest.md +49 -0
  112. data/docs/OptimizeUrl.md +22 -0
  113. data/docs/OutputParam.md +15 -0
  114. data/docs/PaginationMeta.md +22 -0
  115. data/docs/PromoteTemplateVersion200Response.md +18 -0
  116. data/docs/PublicTemplateLibraryItem.md +26 -0
  117. data/docs/ServicesApi.md +497 -0
  118. data/docs/StatusParam.md +15 -0
  119. data/docs/StoreDocumentRequest.md +24 -0
  120. data/docs/Template.md +28 -0
  121. data/docs/TemplateDefinition.md +32 -0
  122. data/docs/TemplateDefinitionDataSettings.md +20 -0
  123. data/docs/TemplateDefinitionEditor.md +18 -0
  124. data/docs/TemplateDefinitionNew.md +34 -0
  125. data/docs/TemplateDefinitionNewDataSettings.md +22 -0
  126. data/docs/TemplateDefinitionNewEditor.md +18 -0
  127. data/docs/TemplateDefinitionNewLayout.md +34 -0
  128. data/docs/TemplateDefinitionNewLayoutMargins.md +24 -0
  129. data/docs/TemplateDefinitionNewLayoutRepeatLayout.md +22 -0
  130. data/docs/TemplateDefinitionNewPagesInner.md +32 -0
  131. data/docs/TemplateDefinitionNewPagesInnerMargins.md +20 -0
  132. data/docs/TemplateDefinitionPagesInner.md +24 -0
  133. data/docs/TemplateLibraryApi.md +139 -0
  134. data/docs/TemplateParam.md +22 -0
  135. data/docs/TemplateParamData.md +49 -0
  136. data/docs/TemplateParamId.md +49 -0
  137. data/docs/TemplateVersion.md +36 -0
  138. data/docs/TemplateVersionCollection.md +20 -0
  139. data/docs/TemplateVersionCollectionMeta.md +22 -0
  140. data/docs/TemplateVersionsApi.md +298 -0
  141. data/docs/TemplatesApi.md +791 -0
  142. data/docs/WatermarkBase64.md +24 -0
  143. data/docs/WatermarkFileUrlWatermark.md +20 -0
  144. data/docs/WatermarkImage.md +26 -0
  145. data/docs/WatermarkImageContentBase64.md +24 -0
  146. data/docs/WatermarkImageContentUrl.md +24 -0
  147. data/docs/WatermarkPosition.md +15 -0
  148. data/docs/WatermarkText.md +28 -0
  149. data/docs/Workspace.md +24 -0
  150. data/docs/WorkspacesApi.md +292 -0
  151. data/git_push.sh +57 -0
  152. data/lib/pdf_generator_api_client/api/assets_api.rb +90 -0
  153. data/lib/pdf_generator_api_client/api/conversion_api.rb +226 -0
  154. data/lib/pdf_generator_api_client/api/documents_api.rb +623 -0
  155. data/lib/pdf_generator_api_client/api/e_invoices_api.rb +283 -0
  156. data/lib/pdf_generator_api_client/api/forms_api.rb +604 -0
  157. data/lib/pdf_generator_api_client/api/misc_api.rb +79 -0
  158. data/lib/pdf_generator_api_client/api/services_api.rb +498 -0
  159. data/lib/pdf_generator_api_client/api/template_library_api.rb +145 -0
  160. data/lib/pdf_generator_api_client/api/template_versions_api.rb +298 -0
  161. data/lib/pdf_generator_api_client/api/templates_api.rb +766 -0
  162. data/lib/pdf_generator_api_client/api/workspaces_api.rb +275 -0
  163. data/lib/pdf_generator_api_client/api_client.rb +393 -0
  164. data/lib/pdf_generator_api_client/api_error.rb +58 -0
  165. data/lib/pdf_generator_api_client/configuration.rb +309 -0
  166. data/lib/pdf_generator_api_client/models/accessibility_option.rb +47 -0
  167. data/lib/pdf_generator_api_client/models/add_watermark_request.rb +105 -0
  168. data/lib/pdf_generator_api_client/models/async_output_param.rb +41 -0
  169. data/lib/pdf_generator_api_client/models/callback_param.rb +232 -0
  170. data/lib/pdf_generator_api_client/models/component.rb +336 -0
  171. data/lib/pdf_generator_api_client/models/convert_html2_pdf_request.rb +324 -0
  172. data/lib/pdf_generator_api_client/models/convert_pdf2_image_request.rb +422 -0
  173. data/lib/pdf_generator_api_client/models/convert_url2_pdf_request.rb +324 -0
  174. data/lib/pdf_generator_api_client/models/copy_template_request.rb +221 -0
  175. data/lib/pdf_generator_api_client/models/create_e_invoice_request.rb +308 -0
  176. data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request.rb +315 -0
  177. data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request_template.rb +242 -0
  178. data/lib/pdf_generator_api_client/models/create_workspace_request.rb +221 -0
  179. data/lib/pdf_generator_api_client/models/data_batch_inner.rb +231 -0
  180. data/lib/pdf_generator_api_client/models/document.rb +261 -0
  181. data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_base64.rb +331 -0
  182. data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_url.rb +331 -0
  183. data/lib/pdf_generator_api_client/models/encrypt_document_request.rb +105 -0
  184. data/lib/pdf_generator_api_client/models/extract_form_fields_request.rb +105 -0
  185. data/lib/pdf_generator_api_client/models/fill_form_fields_request.rb +105 -0
  186. data/lib/pdf_generator_api_client/models/form_action_download.rb +221 -0
  187. data/lib/pdf_generator_api_client/models/form_action_send.rb +221 -0
  188. data/lib/pdf_generator_api_client/models/form_action_send_send_document.rb +250 -0
  189. data/lib/pdf_generator_api_client/models/form_action_send_send_document_headers_inner.rb +283 -0
  190. data/lib/pdf_generator_api_client/models/form_action_store.rb +221 -0
  191. data/lib/pdf_generator_api_client/models/form_configuration.rb +290 -0
  192. data/lib/pdf_generator_api_client/models/form_configuration_new.rb +264 -0
  193. data/lib/pdf_generator_api_client/models/form_configuration_new_actions_inner.rb +105 -0
  194. data/lib/pdf_generator_api_client/models/form_fields_base64.rb +271 -0
  195. data/lib/pdf_generator_api_client/models/form_fields_inner.rb +286 -0
  196. data/lib/pdf_generator_api_client/models/form_fields_url.rb +271 -0
  197. data/lib/pdf_generator_api_client/models/form_fill_base64.rb +321 -0
  198. data/lib/pdf_generator_api_client/models/form_fill_url.rb +321 -0
  199. data/lib/pdf_generator_api_client/models/format_param.rb +40 -0
  200. data/lib/pdf_generator_api_client/models/generate_document_asynchronous_request.rb +318 -0
  201. data/lib/pdf_generator_api_client/models/generate_document_batch_asynchronous_request.rb +308 -0
  202. data/lib/pdf_generator_api_client/models/generate_document_batch_request.rb +299 -0
  203. data/lib/pdf_generator_api_client/models/generate_document_request.rb +309 -0
  204. data/lib/pdf_generator_api_client/models/generate_qr_code201_response.rb +230 -0
  205. data/lib/pdf_generator_api_client/models/generate_qr_code201_response_meta.rb +231 -0
  206. data/lib/pdf_generator_api_client/models/generate_qr_code_request.rb +316 -0
  207. data/lib/pdf_generator_api_client/models/get_status200_response.rb +299 -0
  208. data/lib/pdf_generator_api_client/models/get_template_library200_response.rb +222 -0
  209. data/lib/pdf_generator_api_client/models/get_template_version422_response.rb +220 -0
  210. data/lib/pdf_generator_api_client/models/import_form_base64.rb +247 -0
  211. data/lib/pdf_generator_api_client/models/import_form_request.rb +105 -0
  212. data/lib/pdf_generator_api_client/models/import_form_url.rb +247 -0
  213. data/lib/pdf_generator_api_client/models/import_template_base64.rb +264 -0
  214. data/lib/pdf_generator_api_client/models/import_template_request.rb +105 -0
  215. data/lib/pdf_generator_api_client/models/import_template_url.rb +264 -0
  216. data/lib/pdf_generator_api_client/models/import_template_url_template.rb +238 -0
  217. data/lib/pdf_generator_api_client/models/inline_object.rb +230 -0
  218. data/lib/pdf_generator_api_client/models/inline_object1.rb +220 -0
  219. data/lib/pdf_generator_api_client/models/inline_object10.rb +232 -0
  220. data/lib/pdf_generator_api_client/models/inline_object10_meta.rb +251 -0
  221. data/lib/pdf_generator_api_client/models/inline_object11.rb +230 -0
  222. data/lib/pdf_generator_api_client/models/inline_object11_meta.rb +261 -0
  223. data/lib/pdf_generator_api_client/models/inline_object12.rb +230 -0
  224. data/lib/pdf_generator_api_client/models/inline_object12_meta.rb +270 -0
  225. data/lib/pdf_generator_api_client/models/inline_object12_meta_stats.rb +231 -0
  226. data/lib/pdf_generator_api_client/models/inline_object13.rb +265 -0
  227. data/lib/pdf_generator_api_client/models/inline_object14.rb +223 -0
  228. data/lib/pdf_generator_api_client/models/inline_object14_response_value.rb +401 -0
  229. data/lib/pdf_generator_api_client/models/inline_object14_response_value_default.rb +107 -0
  230. data/lib/pdf_generator_api_client/models/inline_object14_response_value_value.rb +107 -0
  231. data/lib/pdf_generator_api_client/models/inline_object15.rb +231 -0
  232. data/lib/pdf_generator_api_client/models/inline_object16.rb +229 -0
  233. data/lib/pdf_generator_api_client/models/inline_object17.rb +220 -0
  234. data/lib/pdf_generator_api_client/models/inline_object18.rb +230 -0
  235. data/lib/pdf_generator_api_client/models/inline_object18_meta.rb +221 -0
  236. data/lib/pdf_generator_api_client/models/inline_object19.rb +221 -0
  237. data/lib/pdf_generator_api_client/models/inline_object1_response.rb +223 -0
  238. data/lib/pdf_generator_api_client/models/inline_object2.rb +220 -0
  239. data/lib/pdf_generator_api_client/models/inline_object20.rb +220 -0
  240. data/lib/pdf_generator_api_client/models/inline_object20_response.rb +221 -0
  241. data/lib/pdf_generator_api_client/models/inline_object21.rb +255 -0
  242. data/lib/pdf_generator_api_client/models/inline_object22.rb +255 -0
  243. data/lib/pdf_generator_api_client/models/inline_object23.rb +255 -0
  244. data/lib/pdf_generator_api_client/models/inline_object24.rb +255 -0
  245. data/lib/pdf_generator_api_client/models/inline_object25.rb +231 -0
  246. data/lib/pdf_generator_api_client/models/inline_object26.rb +221 -0
  247. data/lib/pdf_generator_api_client/models/inline_object27.rb +221 -0
  248. data/lib/pdf_generator_api_client/models/inline_object3.rb +220 -0
  249. data/lib/pdf_generator_api_client/models/inline_object4.rb +231 -0
  250. data/lib/pdf_generator_api_client/models/inline_object5.rb +231 -0
  251. data/lib/pdf_generator_api_client/models/inline_object6.rb +231 -0
  252. data/lib/pdf_generator_api_client/models/inline_object7.rb +220 -0
  253. data/lib/pdf_generator_api_client/models/inline_object7_response.rb +220 -0
  254. data/lib/pdf_generator_api_client/models/inline_object8.rb +220 -0
  255. data/lib/pdf_generator_api_client/models/inline_object9.rb +230 -0
  256. data/lib/pdf_generator_api_client/models/inline_object9_meta.rb +261 -0
  257. data/lib/pdf_generator_api_client/models/inline_object_meta.rb +231 -0
  258. data/lib/pdf_generator_api_client/models/key_field_param.rb +40 -0
  259. data/lib/pdf_generator_api_client/models/make_accessible_base64.rb +315 -0
  260. data/lib/pdf_generator_api_client/models/make_accessible_request.rb +105 -0
  261. data/lib/pdf_generator_api_client/models/make_accessible_url.rb +315 -0
  262. data/lib/pdf_generator_api_client/models/metadata_param.rb +236 -0
  263. data/lib/pdf_generator_api_client/models/open_editor_request.rb +264 -0
  264. data/lib/pdf_generator_api_client/models/open_editor_request_data.rb +106 -0
  265. data/lib/pdf_generator_api_client/models/optimize_base64.rb +294 -0
  266. data/lib/pdf_generator_api_client/models/optimize_document_request.rb +105 -0
  267. data/lib/pdf_generator_api_client/models/optimize_url.rb +294 -0
  268. data/lib/pdf_generator_api_client/models/output_param.rb +42 -0
  269. data/lib/pdf_generator_api_client/models/pagination_meta.rb +239 -0
  270. data/lib/pdf_generator_api_client/models/promote_template_version200_response.rb +220 -0
  271. data/lib/pdf_generator_api_client/models/public_template_library_item.rb +265 -0
  272. data/lib/pdf_generator_api_client/models/status_param.rb +40 -0
  273. data/lib/pdf_generator_api_client/models/store_document_request.rb +289 -0
  274. data/lib/pdf_generator_api_client/models/template.rb +274 -0
  275. data/lib/pdf_generator_api_client/models/template_definition.rb +292 -0
  276. data/lib/pdf_generator_api_client/models/template_definition_data_settings.rb +234 -0
  277. data/lib/pdf_generator_api_client/models/template_definition_editor.rb +221 -0
  278. data/lib/pdf_generator_api_client/models/template_definition_new.rb +324 -0
  279. data/lib/pdf_generator_api_client/models/template_definition_new_data_settings.rb +245 -0
  280. data/lib/pdf_generator_api_client/models/template_definition_new_editor.rb +221 -0
  281. data/lib/pdf_generator_api_client/models/template_definition_new_layout.rb +377 -0
  282. data/lib/pdf_generator_api_client/models/template_definition_new_layout_margins.rb +248 -0
  283. data/lib/pdf_generator_api_client/models/template_definition_new_layout_repeat_layout.rb +276 -0
  284. data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner.rb +295 -0
  285. data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner_margins.rb +231 -0
  286. data/lib/pdf_generator_api_client/models/template_definition_pages_inner.rb +251 -0
  287. data/lib/pdf_generator_api_client/models/template_param.rb +240 -0
  288. data/lib/pdf_generator_api_client/models/template_param_data.rb +105 -0
  289. data/lib/pdf_generator_api_client/models/template_param_id.rb +106 -0
  290. data/lib/pdf_generator_api_client/models/template_version.rb +301 -0
  291. data/lib/pdf_generator_api_client/models/template_version_collection.rb +231 -0
  292. data/lib/pdf_generator_api_client/models/template_version_collection_meta.rb +238 -0
  293. data/lib/pdf_generator_api_client/models/watermark_base64.rb +320 -0
  294. data/lib/pdf_generator_api_client/models/watermark_file_url_watermark.rb +229 -0
  295. data/lib/pdf_generator_api_client/models/watermark_image.rb +104 -0
  296. data/lib/pdf_generator_api_client/models/watermark_image_content_base64.rb +351 -0
  297. data/lib/pdf_generator_api_client/models/watermark_image_content_url.rb +351 -0
  298. data/lib/pdf_generator_api_client/models/watermark_position.rb +47 -0
  299. data/lib/pdf_generator_api_client/models/watermark_text.rb +403 -0
  300. data/lib/pdf_generator_api_client/models/workspace.rb +250 -0
  301. data/lib/pdf_generator_api_client/version.rb +15 -0
  302. data/lib/pdf_generator_api_client.rb +185 -0
  303. data/pdf_generator_api_client.gemspec +39 -0
  304. data/spec/api/assets_api_spec.rb +47 -0
  305. data/spec/api/conversion_api_spec.rb +71 -0
  306. data/spec/api/documents_api_spec.rb +147 -0
  307. data/spec/api/e_invoices_api_spec.rb +82 -0
  308. data/spec/api/forms_api_spec.rb +144 -0
  309. data/spec/api/misc_api_spec.rb +46 -0
  310. data/spec/api/services_api_spec.rb +119 -0
  311. data/spec/api/template_library_api_spec.rb +59 -0
  312. data/spec/api/template_versions_api_spec.rb +88 -0
  313. data/spec/api/templates_api_spec.rb +173 -0
  314. data/spec/api/workspaces_api_spec.rb +84 -0
  315. data/spec/models/accessibility_option_spec.rb +30 -0
  316. data/spec/models/add_watermark_request_spec.rb +32 -0
  317. data/spec/models/async_output_param_spec.rb +30 -0
  318. data/spec/models/callback_param_spec.rb +42 -0
  319. data/spec/models/component_spec.rb +88 -0
  320. data/spec/models/convert_html2_pdf_request_spec.rb +72 -0
  321. data/spec/models/convert_pdf2_image_request_spec.rb +86 -0
  322. data/spec/models/convert_url2_pdf_request_spec.rb +72 -0
  323. data/spec/models/copy_template_request_spec.rb +36 -0
  324. data/spec/models/create_e_invoice_request_spec.rb +56 -0
  325. data/spec/models/create_factur_xe_invoice_request_spec.rb +64 -0
  326. data/spec/models/create_factur_xe_invoice_request_template_spec.rb +48 -0
  327. data/spec/models/create_workspace_request_spec.rb +36 -0
  328. data/spec/models/data_batch_inner_spec.rb +42 -0
  329. data/spec/models/document_spec.rb +60 -0
  330. data/spec/models/encrypt_and_decrypt_base64_spec.rb +64 -0
  331. data/spec/models/encrypt_and_decrypt_url_spec.rb +64 -0
  332. data/spec/models/encrypt_document_request_spec.rb +32 -0
  333. data/spec/models/extract_form_fields_request_spec.rb +32 -0
  334. data/spec/models/fill_form_fields_request_spec.rb +32 -0
  335. data/spec/models/form_action_download_spec.rb +36 -0
  336. data/spec/models/form_action_send_send_document_headers_inner_spec.rb +42 -0
  337. data/spec/models/form_action_send_send_document_spec.rb +42 -0
  338. data/spec/models/form_action_send_spec.rb +36 -0
  339. data/spec/models/form_action_store_spec.rb +36 -0
  340. data/spec/models/form_configuration_new_actions_inner_spec.rb +21 -0
  341. data/spec/models/form_configuration_new_spec.rb +60 -0
  342. data/spec/models/form_configuration_spec.rb +48 -0
  343. data/spec/models/form_fields_base64_spec.rb +42 -0
  344. data/spec/models/form_fields_inner_spec.rb +58 -0
  345. data/spec/models/form_fields_url_spec.rb +42 -0
  346. data/spec/models/form_fill_base64_spec.rb +58 -0
  347. data/spec/models/form_fill_url_spec.rb +58 -0
  348. data/spec/models/format_param_spec.rb +30 -0
  349. data/spec/models/generate_document_asynchronous_request_spec.rb +78 -0
  350. data/spec/models/generate_document_batch_asynchronous_request_spec.rb +72 -0
  351. data/spec/models/generate_document_batch_request_spec.rb +66 -0
  352. data/spec/models/generate_document_request_spec.rb +72 -0
  353. data/spec/models/generate_qr_code201_response_meta_spec.rb +42 -0
  354. data/spec/models/generate_qr_code201_response_spec.rb +42 -0
  355. data/spec/models/generate_qr_code_request_spec.rb +64 -0
  356. data/spec/models/get_status200_response_spec.rb +66 -0
  357. data/spec/models/get_template_library200_response_spec.rb +36 -0
  358. data/spec/models/get_template_version422_response_spec.rb +36 -0
  359. data/spec/models/import_form_base64_spec.rb +42 -0
  360. data/spec/models/import_form_request_spec.rb +32 -0
  361. data/spec/models/import_form_url_spec.rb +42 -0
  362. data/spec/models/import_template_base64_spec.rb +42 -0
  363. data/spec/models/import_template_request_spec.rb +32 -0
  364. data/spec/models/import_template_url_spec.rb +42 -0
  365. data/spec/models/import_template_url_template_spec.rb +36 -0
  366. data/spec/models/inline_object10_meta_spec.rb +54 -0
  367. data/spec/models/inline_object10_spec.rb +42 -0
  368. data/spec/models/inline_object11_meta_spec.rb +60 -0
  369. data/spec/models/inline_object11_spec.rb +42 -0
  370. data/spec/models/inline_object12_meta_spec.rb +66 -0
  371. data/spec/models/inline_object12_meta_stats_spec.rb +42 -0
  372. data/spec/models/inline_object12_spec.rb +42 -0
  373. data/spec/models/inline_object13_spec.rb +46 -0
  374. data/spec/models/inline_object14_response_value_default_spec.rb +32 -0
  375. data/spec/models/inline_object14_response_value_spec.rb +124 -0
  376. data/spec/models/inline_object14_response_value_value_spec.rb +32 -0
  377. data/spec/models/inline_object14_spec.rb +36 -0
  378. data/spec/models/inline_object15_spec.rb +42 -0
  379. data/spec/models/inline_object16_spec.rb +42 -0
  380. data/spec/models/inline_object17_spec.rb +36 -0
  381. data/spec/models/inline_object18_meta_spec.rb +36 -0
  382. data/spec/models/inline_object18_spec.rb +42 -0
  383. data/spec/models/inline_object19_spec.rb +36 -0
  384. data/spec/models/inline_object1_response_spec.rb +36 -0
  385. data/spec/models/inline_object1_spec.rb +36 -0
  386. data/spec/models/inline_object20_response_spec.rb +36 -0
  387. data/spec/models/inline_object20_spec.rb +36 -0
  388. data/spec/models/inline_object21_spec.rb +40 -0
  389. data/spec/models/inline_object22_spec.rb +40 -0
  390. data/spec/models/inline_object23_spec.rb +40 -0
  391. data/spec/models/inline_object24_spec.rb +40 -0
  392. data/spec/models/inline_object25_spec.rb +42 -0
  393. data/spec/models/inline_object26_spec.rb +36 -0
  394. data/spec/models/inline_object27_spec.rb +36 -0
  395. data/spec/models/inline_object2_spec.rb +36 -0
  396. data/spec/models/inline_object3_spec.rb +36 -0
  397. data/spec/models/inline_object4_spec.rb +42 -0
  398. data/spec/models/inline_object5_spec.rb +42 -0
  399. data/spec/models/inline_object6_spec.rb +42 -0
  400. data/spec/models/inline_object7_response_spec.rb +36 -0
  401. data/spec/models/inline_object7_spec.rb +36 -0
  402. data/spec/models/inline_object8_spec.rb +36 -0
  403. data/spec/models/inline_object9_meta_spec.rb +60 -0
  404. data/spec/models/inline_object9_spec.rb +42 -0
  405. data/spec/models/inline_object_meta_spec.rb +42 -0
  406. data/spec/models/inline_object_spec.rb +42 -0
  407. data/spec/models/key_field_param_spec.rb +30 -0
  408. data/spec/models/make_accessible_base64_spec.rb +64 -0
  409. data/spec/models/make_accessible_request_spec.rb +32 -0
  410. data/spec/models/make_accessible_url_spec.rb +64 -0
  411. data/spec/models/metadata_param_spec.rb +42 -0
  412. data/spec/models/open_editor_request_data_spec.rb +32 -0
  413. data/spec/models/open_editor_request_spec.rb +46 -0
  414. data/spec/models/optimize_base64_spec.rb +52 -0
  415. data/spec/models/optimize_document_request_spec.rb +32 -0
  416. data/spec/models/optimize_url_spec.rb +52 -0
  417. data/spec/models/output_param_spec.rb +30 -0
  418. data/spec/models/pagination_meta_spec.rb +48 -0
  419. data/spec/models/promote_template_version200_response_spec.rb +36 -0
  420. data/spec/models/public_template_library_item_spec.rb +60 -0
  421. data/spec/models/status_param_spec.rb +30 -0
  422. data/spec/models/store_document_request_spec.rb +58 -0
  423. data/spec/models/template_definition_data_settings_spec.rb +42 -0
  424. data/spec/models/template_definition_editor_spec.rb +36 -0
  425. data/spec/models/template_definition_new_data_settings_spec.rb +48 -0
  426. data/spec/models/template_definition_new_editor_spec.rb +36 -0
  427. data/spec/models/template_definition_new_layout_margins_spec.rb +54 -0
  428. data/spec/models/template_definition_new_layout_repeat_layout_spec.rb +52 -0
  429. data/spec/models/template_definition_new_layout_spec.rb +100 -0
  430. data/spec/models/template_definition_new_pages_inner_margins_spec.rb +42 -0
  431. data/spec/models/template_definition_new_pages_inner_spec.rb +78 -0
  432. data/spec/models/template_definition_new_spec.rb +84 -0
  433. data/spec/models/template_definition_pages_inner_spec.rb +54 -0
  434. data/spec/models/template_definition_spec.rb +78 -0
  435. data/spec/models/template_param_data_spec.rb +32 -0
  436. data/spec/models/template_param_id_spec.rb +32 -0
  437. data/spec/models/template_param_spec.rb +48 -0
  438. data/spec/models/template_spec.rb +66 -0
  439. data/spec/models/template_version_collection_meta_spec.rb +48 -0
  440. data/spec/models/template_version_collection_spec.rb +42 -0
  441. data/spec/models/template_version_spec.rb +90 -0
  442. data/spec/models/watermark_base64_spec.rb +58 -0
  443. data/spec/models/watermark_file_url_watermark_spec.rb +42 -0
  444. data/spec/models/watermark_image_content_base64_spec.rb +54 -0
  445. data/spec/models/watermark_image_content_url_spec.rb +54 -0
  446. data/spec/models/watermark_image_spec.rb +21 -0
  447. data/spec/models/watermark_position_spec.rb +30 -0
  448. data/spec/models/watermark_text_spec.rb +66 -0
  449. data/spec/models/workspace_spec.rb +54 -0
  450. data/spec/spec_helper.rb +111 -0
  451. metadata +679 -0
@@ -0,0 +1,264 @@
1
+ =begin
2
+ #PDF Generator API
3
+
4
+ ## Introduction [PDF Generator API](https://pdfgeneratorapi.com) allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor. The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding. ## Base URL The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v4` For example * `https://us1.pdfgeneratorapi.com/api/v4/templates` * `https://us1.pdfgeneratorapi.com/api/v4/workspaces` * `https://us1.pdfgeneratorapi.com/api/v4/templates/123123` ## Editor PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our [Support Portal](https://support.pdfgeneratorapi.com). * [Component specification](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/) * [Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/) * [Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/) ## Definitions ### Organization Organization is a group of workspaces owned by your account. ### Workspace Workspace contains templates. Each workspace has access to their own templates and organization default templates. ### Master Workspace Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with. ### Default Template Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has \"Organization\" access then your users can use them from the \"New\" menu in the Editor. ### Data Field Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field `{paymentDetails::buyerName}`. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template. ``` { \"documentNumber\": 1, \"paymentDetails\": { \"method\": \"Credit Card\", \"buyerName\": \"John Smith\" }, \"items\": [ { \"id\": 1, \"name\": \"Item one\" } ] } ``` ## Rate limiting Our API endpoints use IP-based rate limiting and allow you to make up to 2 requests per second and 60 requests per minute. If you make more requests, you will receive a response with HTTP code 429. Response headers contain additional values: | Header | Description | |--------|--------------------------------| | X-RateLimit-Limit | Maximum requests per minute | | X-RateLimit-Remaining | The requests remaining in the current minute | | Retry-After | How many seconds you need to wait until you are allowed to make requests | * * * * * # Libraries and SDKs ## Postman Collection We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code. ## Client Libraries All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language. * [PHP Client](https://github.com/pdfgeneratorapi/php-client) * [Java Client](https://github.com/pdfgeneratorapi/java-client) * [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client) * [Python Client](https://github.com/pdfgeneratorapi/python-client) * [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client) We have validated the generated libraries, but let us know if you find any anomalies in the client code. ## Model Context Protocol (MCP) Server Integrate document generation directly into your AI agents and LLM applications using our official Model Context Protocol (MCP) Server. The MCP server provides a standardized interface that allows AI assistants (like Claude Desktop and other MCP-compatible clients) to securely interact with the PDF Generator API. With it, your AI applications can automatically fetch workspaces, retrieve templates, merge data, and generate PDF documents on the fly. [Get PDF Generator API MCP Server](https://github.com/pdfgeneratorapi/mcp-server) * * * * * # Authentication The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request. <SecurityDefinitions /> ## Accessing your API Key and Secret You can find your __API Key__ and __API Secret__ from the __Account Settings__ page after you login to PDF Generator API [here](https://pdfgeneratorapi.com/login). ## Creating a JWT JSON Web Tokens are composed of three sections: a header, a payload (containing a claim set), and a signature. The header and payload are JSON objects, which are serialized to UTF-8 bytes, then encoded using base64url encoding. The JWT's header, payload, and signature are concatenated with periods (.). As a result, a JWT typically takes the following form: ``` {Base64url encoded header}.{Base64url encoded payload}.{Base64url encoded signature} ``` We recommend and support libraries provided on [jwt.io](https://jwt.io/). While other libraries can create JWT, these recommended libraries are the most robust. ### Header Property `alg` defines which signing algorithm is being used. PDF Generator API users HS256. Property `typ` defines the type of token and it is always JWT. ``` { \"alg\": \"HS256\", \"typ\": \"JWT\" } ``` ### Payload The second part of the token is the payload, which contains the claims or the pieces of information being passed about the user and any metadata required. It is mandatory to specify the following claims: * issuer (`iss`): Your API key * subject (`sub`): Workspace identifier * expiration time (`exp`): Timestamp (unix epoch time) until the token is valid. It is highly recommended to set the exp timestamp for a short period, i.e. a matter of seconds. This way, if a token is intercepted or shared, the token will only be valid for a short period of time. ``` { \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\", \"sub\": \"demo.example@actualreports.com\", \"exp\": 1586112639 } ``` ### Payload for Partners Our partners can send their unique identifier (provided by us) in JWT's partner_id claim. If the `partner_id` value is specified in the JWT, the organization making the request is automatically connected to the partner account. * Partner ID (`partner_id`): Unique identifier provide by PDF Generator API team ``` { \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\", \"sub\": \"demo.example@actualreports.com\", \"partner_id\": \"my-partner-identifier\", \"exp\": 1586112639 } ``` ### Signature To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. The signature is used to verify the message wasn't changed along the way, and, in the case of tokens signed with a private key, it can also verify that the sender of the JWT is who it says it is. ``` HMACSHA256( base64UrlEncode(header) + \".\" + base64UrlEncode(payload), API_SECRET) ``` ### Putting all together The output is three Base64-URL strings separated by dots. The following shows a JWT that has the previous header and payload encoded, and it is signed with a secret. ``` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q // Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 // Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0 // Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q ``` ## Temporary JWTs You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) page after you login to PDF Generator API. The generated token uses your email address as the subject (`sub`) value and is valid for __15 minutes__. You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications. * * * * * # Error codes | Code | Description | |--------|--------------------------------| | 401 | Unauthorized | | 402 | Payment Required | | 403 | Forbidden | | 404 | Not Found | | 422 | Unprocessable Entity | | 429 | Too Many Requests | | 500 | Internal Server Error | ## 401 Unauthorized | Description | |-------------------------------------------------------------------------| | Authentication failed: request expired | | Authentication failed: workspace missing | | Authentication failed: key missing | | Authentication failed: property 'iss' (issuer) missing in JWT | | Authentication failed: property 'sub' (subject) missing in JWT | | Authentication failed: property 'exp' (expiration time) missing in JWT | | Authentication failed: incorrect signature | ## 402 Payment Required | Description | |-------------------------------------------------------------------------| | Your account is suspended, please upgrade your account | ## 403 Forbidden | Description | |-------------------------------------------------------------------------| | Your account has exceeded the monthly document generation limit. | | Access not granted: You cannot delete master workspace via API | | Access not granted: Template is not accessible by this organization | | Your session has expired, please close and reopen the editor. | ## 404 Entity not found | Description | |-------------------------------------------------------------------------| | Entity not found | | Resource not found | | None of the templates is available for the workspace. | ## 422 Unprocessable Entity | Description | |-------------------------------------------------------------------------| | Unable to parse JSON, please check formatting | | Required parameter missing | | Required parameter missing: template definition not defined | | Required parameter missing: template not defined | ## 429 Too Many Requests | Description | |-------------------------------------------------------------------------| | You can make up to 2 requests per second and 60 requests per minute. | * * * * *
5
+
6
+ The version of the OpenAPI document: 4.0.25
7
+ Contact: support@pdfgeneratorapi.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.14.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module PDFGeneratorAPI
17
+ class FormConfigurationNew
18
+ # Template ID which is connected to the form
19
+ attr_accessor :template_id
20
+
21
+ # Form name
22
+ attr_accessor :name
23
+
24
+ # Array of action configurations
25
+ attr_accessor :actions
26
+
27
+ # A list of form field objects
28
+ attr_accessor :fields
29
+
30
+ attr_accessor :configuration
31
+
32
+ # Attribute mapping from ruby-style variable name to JSON key.
33
+ def self.attribute_map
34
+ {
35
+ :'template_id' => :'template_id',
36
+ :'name' => :'name',
37
+ :'actions' => :'actions',
38
+ :'fields' => :'fields',
39
+ :'configuration' => :'configuration'
40
+ }
41
+ end
42
+
43
+ # Returns attribute mapping this model knows about
44
+ def self.acceptable_attribute_map
45
+ attribute_map
46
+ end
47
+
48
+ # Returns all the JSON keys this model knows about
49
+ def self.acceptable_attributes
50
+ acceptable_attribute_map.values
51
+ end
52
+
53
+ # Attribute type mapping.
54
+ def self.openapi_types
55
+ {
56
+ :'template_id' => :'Integer',
57
+ :'name' => :'String',
58
+ :'actions' => :'Array<FormConfigurationNewActionsInner>',
59
+ :'fields' => :'Array<FormFieldsInner>',
60
+ :'configuration' => :'FormConfiguration'
61
+ }
62
+ end
63
+
64
+ # List of attributes with nullable: true
65
+ def self.openapi_nullable
66
+ Set.new([
67
+ ])
68
+ end
69
+
70
+ # Initializes the object
71
+ # @param [Hash] attributes Model attributes in the form of hash
72
+ def initialize(attributes = {})
73
+ if (!attributes.is_a?(Hash))
74
+ fail ArgumentError, "The input argument (attributes) must be a hash in `PDFGeneratorAPI::FormConfigurationNew` initialize method"
75
+ end
76
+
77
+ # check to see if the attribute exists and convert string to symbol for hash key
78
+ acceptable_attribute_map = self.class.acceptable_attribute_map
79
+ attributes = attributes.each_with_object({}) { |(k, v), h|
80
+ if (!acceptable_attribute_map.key?(k.to_sym))
81
+ fail ArgumentError, "`#{k}` is not a valid attribute in `PDFGeneratorAPI::FormConfigurationNew`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
82
+ end
83
+ h[k.to_sym] = v
84
+ }
85
+
86
+ if attributes.key?(:'template_id')
87
+ self.template_id = attributes[:'template_id']
88
+ end
89
+
90
+ if attributes.key?(:'name')
91
+ self.name = attributes[:'name']
92
+ end
93
+
94
+ if attributes.key?(:'actions')
95
+ if (value = attributes[:'actions']).is_a?(Array)
96
+ self.actions = value
97
+ end
98
+ end
99
+
100
+ if attributes.key?(:'fields')
101
+ if (value = attributes[:'fields']).is_a?(Array)
102
+ self.fields = value
103
+ end
104
+ end
105
+
106
+ if attributes.key?(:'configuration')
107
+ self.configuration = attributes[:'configuration']
108
+ end
109
+ end
110
+
111
+ # Show invalid properties with the reasons. Usually used together with valid?
112
+ # @return Array for valid properties with the reasons
113
+ def list_invalid_properties
114
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
115
+ invalid_properties = Array.new
116
+ invalid_properties
117
+ end
118
+
119
+ # Check to see if the all the properties in the model are valid
120
+ # @return true if the model is valid
121
+ def valid?
122
+ warn '[DEPRECATED] the `valid?` method is obsolete'
123
+ true
124
+ end
125
+
126
+ # Checks equality by comparing each attribute.
127
+ # @param [Object] Object to be compared
128
+ def ==(o)
129
+ return true if self.equal?(o)
130
+ self.class == o.class &&
131
+ template_id == o.template_id &&
132
+ name == o.name &&
133
+ actions == o.actions &&
134
+ fields == o.fields &&
135
+ configuration == o.configuration
136
+ end
137
+
138
+ # @see the `==` method
139
+ # @param [Object] Object to be compared
140
+ def eql?(o)
141
+ self == o
142
+ end
143
+
144
+ # Calculates hash code according to all attributes.
145
+ # @return [Integer] Hash code
146
+ def hash
147
+ [template_id, name, actions, fields, configuration].hash
148
+ end
149
+
150
+ # Builds the object from hash
151
+ # @param [Hash] attributes Model attributes in the form of hash
152
+ # @return [Object] Returns the model itself
153
+ def self.build_from_hash(attributes)
154
+ return nil unless attributes.is_a?(Hash)
155
+ attributes = attributes.transform_keys(&:to_sym)
156
+ transformed_hash = {}
157
+ openapi_types.each_pair do |key, type|
158
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
159
+ transformed_hash["#{key}"] = nil
160
+ elsif type =~ /\AArray<(.*)>/i
161
+ # check to ensure the input is an array given that the attribute
162
+ # is documented as an array but the input is not
163
+ if attributes[attribute_map[key]].is_a?(Array)
164
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
165
+ end
166
+ elsif !attributes[attribute_map[key]].nil?
167
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
168
+ end
169
+ end
170
+ new(transformed_hash)
171
+ end
172
+
173
+ # Deserializes the data based on type
174
+ # @param string type Data type
175
+ # @param string value Value to be deserialized
176
+ # @return [Object] Deserialized data
177
+ def self._deserialize(type, value)
178
+ case type.to_sym
179
+ when :Time
180
+ Time.parse(value)
181
+ when :Date
182
+ Date.parse(value)
183
+ when :String
184
+ value.to_s
185
+ when :Integer
186
+ value.to_i
187
+ when :Float
188
+ value.to_f
189
+ when :Boolean
190
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
191
+ true
192
+ else
193
+ false
194
+ end
195
+ when :Object
196
+ # generic object (usually a Hash), return directly
197
+ value
198
+ when /\AArray<(?<inner_type>.+)>\z/
199
+ inner_type = Regexp.last_match[:inner_type]
200
+ value.map { |v| _deserialize(inner_type, v) }
201
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
202
+ k_type = Regexp.last_match[:k_type]
203
+ v_type = Regexp.last_match[:v_type]
204
+ {}.tap do |hash|
205
+ value.each do |k, v|
206
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
207
+ end
208
+ end
209
+ else # model
210
+ # models (e.g. Pet) or oneOf
211
+ klass = PDFGeneratorAPI.const_get(type)
212
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
213
+ end
214
+ end
215
+
216
+ # Returns the string representation of the object
217
+ # @return [String] String presentation of the object
218
+ def to_s
219
+ to_hash.to_s
220
+ end
221
+
222
+ # to_body is an alias to to_hash (backward compatibility)
223
+ # @return [Hash] Returns the object in the form of hash
224
+ def to_body
225
+ to_hash
226
+ end
227
+
228
+ # Returns the object in the form of hash
229
+ # @return [Hash] Returns the object in the form of hash
230
+ def to_hash
231
+ hash = {}
232
+ self.class.attribute_map.each_pair do |attr, param|
233
+ value = self.send(attr)
234
+ if value.nil?
235
+ is_nullable = self.class.openapi_nullable.include?(attr)
236
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
237
+ end
238
+
239
+ hash[param] = _to_hash(value)
240
+ end
241
+ hash
242
+ end
243
+
244
+ # Outputs non-array value in the form of hash
245
+ # For object, use to_hash. Otherwise, just return the value
246
+ # @param [Object] value Any valid value
247
+ # @return [Hash] Returns the value in the form of hash
248
+ def _to_hash(value)
249
+ if value.is_a?(Array)
250
+ value.compact.map { |v| _to_hash(v) }
251
+ elsif value.is_a?(Hash)
252
+ {}.tap do |hash|
253
+ value.each { |k, v| hash[k] = _to_hash(v) }
254
+ end
255
+ elsif value.respond_to? :to_hash
256
+ value.to_hash
257
+ else
258
+ value
259
+ end
260
+ end
261
+
262
+ end
263
+
264
+ end
@@ -0,0 +1,105 @@
1
+ =begin
2
+ #PDF Generator API
3
+
4
+ ## Introduction [PDF Generator API](https://pdfgeneratorapi.com) allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor. The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding. ## Base URL The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v4` For example * `https://us1.pdfgeneratorapi.com/api/v4/templates` * `https://us1.pdfgeneratorapi.com/api/v4/workspaces` * `https://us1.pdfgeneratorapi.com/api/v4/templates/123123` ## Editor PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our [Support Portal](https://support.pdfgeneratorapi.com). * [Component specification](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/) * [Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/) * [Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/) ## Definitions ### Organization Organization is a group of workspaces owned by your account. ### Workspace Workspace contains templates. Each workspace has access to their own templates and organization default templates. ### Master Workspace Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with. ### Default Template Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has \"Organization\" access then your users can use them from the \"New\" menu in the Editor. ### Data Field Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field `{paymentDetails::buyerName}`. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template. ``` { \"documentNumber\": 1, \"paymentDetails\": { \"method\": \"Credit Card\", \"buyerName\": \"John Smith\" }, \"items\": [ { \"id\": 1, \"name\": \"Item one\" } ] } ``` ## Rate limiting Our API endpoints use IP-based rate limiting and allow you to make up to 2 requests per second and 60 requests per minute. If you make more requests, you will receive a response with HTTP code 429. Response headers contain additional values: | Header | Description | |--------|--------------------------------| | X-RateLimit-Limit | Maximum requests per minute | | X-RateLimit-Remaining | The requests remaining in the current minute | | Retry-After | How many seconds you need to wait until you are allowed to make requests | * * * * * # Libraries and SDKs ## Postman Collection We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code. ## Client Libraries All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language. * [PHP Client](https://github.com/pdfgeneratorapi/php-client) * [Java Client](https://github.com/pdfgeneratorapi/java-client) * [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client) * [Python Client](https://github.com/pdfgeneratorapi/python-client) * [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client) We have validated the generated libraries, but let us know if you find any anomalies in the client code. ## Model Context Protocol (MCP) Server Integrate document generation directly into your AI agents and LLM applications using our official Model Context Protocol (MCP) Server. The MCP server provides a standardized interface that allows AI assistants (like Claude Desktop and other MCP-compatible clients) to securely interact with the PDF Generator API. With it, your AI applications can automatically fetch workspaces, retrieve templates, merge data, and generate PDF documents on the fly. [Get PDF Generator API MCP Server](https://github.com/pdfgeneratorapi/mcp-server) * * * * * # Authentication The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request. <SecurityDefinitions /> ## Accessing your API Key and Secret You can find your __API Key__ and __API Secret__ from the __Account Settings__ page after you login to PDF Generator API [here](https://pdfgeneratorapi.com/login). ## Creating a JWT JSON Web Tokens are composed of three sections: a header, a payload (containing a claim set), and a signature. The header and payload are JSON objects, which are serialized to UTF-8 bytes, then encoded using base64url encoding. The JWT's header, payload, and signature are concatenated with periods (.). As a result, a JWT typically takes the following form: ``` {Base64url encoded header}.{Base64url encoded payload}.{Base64url encoded signature} ``` We recommend and support libraries provided on [jwt.io](https://jwt.io/). While other libraries can create JWT, these recommended libraries are the most robust. ### Header Property `alg` defines which signing algorithm is being used. PDF Generator API users HS256. Property `typ` defines the type of token and it is always JWT. ``` { \"alg\": \"HS256\", \"typ\": \"JWT\" } ``` ### Payload The second part of the token is the payload, which contains the claims or the pieces of information being passed about the user and any metadata required. It is mandatory to specify the following claims: * issuer (`iss`): Your API key * subject (`sub`): Workspace identifier * expiration time (`exp`): Timestamp (unix epoch time) until the token is valid. It is highly recommended to set the exp timestamp for a short period, i.e. a matter of seconds. This way, if a token is intercepted or shared, the token will only be valid for a short period of time. ``` { \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\", \"sub\": \"demo.example@actualreports.com\", \"exp\": 1586112639 } ``` ### Payload for Partners Our partners can send their unique identifier (provided by us) in JWT's partner_id claim. If the `partner_id` value is specified in the JWT, the organization making the request is automatically connected to the partner account. * Partner ID (`partner_id`): Unique identifier provide by PDF Generator API team ``` { \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\", \"sub\": \"demo.example@actualreports.com\", \"partner_id\": \"my-partner-identifier\", \"exp\": 1586112639 } ``` ### Signature To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. The signature is used to verify the message wasn't changed along the way, and, in the case of tokens signed with a private key, it can also verify that the sender of the JWT is who it says it is. ``` HMACSHA256( base64UrlEncode(header) + \".\" + base64UrlEncode(payload), API_SECRET) ``` ### Putting all together The output is three Base64-URL strings separated by dots. The following shows a JWT that has the previous header and payload encoded, and it is signed with a secret. ``` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q // Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 // Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0 // Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q ``` ## Temporary JWTs You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) page after you login to PDF Generator API. The generated token uses your email address as the subject (`sub`) value and is valid for __15 minutes__. You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications. * * * * * # Error codes | Code | Description | |--------|--------------------------------| | 401 | Unauthorized | | 402 | Payment Required | | 403 | Forbidden | | 404 | Not Found | | 422 | Unprocessable Entity | | 429 | Too Many Requests | | 500 | Internal Server Error | ## 401 Unauthorized | Description | |-------------------------------------------------------------------------| | Authentication failed: request expired | | Authentication failed: workspace missing | | Authentication failed: key missing | | Authentication failed: property 'iss' (issuer) missing in JWT | | Authentication failed: property 'sub' (subject) missing in JWT | | Authentication failed: property 'exp' (expiration time) missing in JWT | | Authentication failed: incorrect signature | ## 402 Payment Required | Description | |-------------------------------------------------------------------------| | Your account is suspended, please upgrade your account | ## 403 Forbidden | Description | |-------------------------------------------------------------------------| | Your account has exceeded the monthly document generation limit. | | Access not granted: You cannot delete master workspace via API | | Access not granted: Template is not accessible by this organization | | Your session has expired, please close and reopen the editor. | ## 404 Entity not found | Description | |-------------------------------------------------------------------------| | Entity not found | | Resource not found | | None of the templates is available for the workspace. | ## 422 Unprocessable Entity | Description | |-------------------------------------------------------------------------| | Unable to parse JSON, please check formatting | | Required parameter missing | | Required parameter missing: template definition not defined | | Required parameter missing: template not defined | ## 429 Too Many Requests | Description | |-------------------------------------------------------------------------| | You can make up to 2 requests per second and 60 requests per minute. | * * * * *
5
+
6
+ The version of the OpenAPI document: 4.0.25
7
+ Contact: support@pdfgeneratorapi.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.14.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module PDFGeneratorAPI
17
+ module FormConfigurationNewActionsInner
18
+ class << self
19
+ # List of class defined in anyOf (OpenAPI v3)
20
+ def openapi_any_of
21
+ [
22
+ :'FormActionDownload',
23
+ :'FormActionSend',
24
+ :'FormActionStore'
25
+ ]
26
+ end
27
+
28
+ # Builds the object
29
+ # @param [Mixed] Data to be matched against the list of anyOf items
30
+ # @return [Object] Returns the model or the data itself
31
+ def build(data)
32
+ # Go through the list of anyOf items and attempt to identify the appropriate one.
33
+ # Note:
34
+ # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
35
+ # due to the way the deserialization is made in the base_object template (it just casts without verifying).
36
+ # - TODO: scalar values are de facto behaving as if they were nullable.
37
+ # - TODO: logging when debugging is set.
38
+ openapi_any_of.each do |klass|
39
+ begin
40
+ next if klass == :AnyType # "nullable: true"
41
+ typed_data = find_and_cast_into_type(klass, data)
42
+ return typed_data if typed_data
43
+ rescue # rescue all errors so we keep iterating even if the current item lookup raises
44
+ end
45
+ end
46
+
47
+ openapi_any_of.include?(:AnyType) ? data : nil
48
+ end
49
+
50
+ private
51
+
52
+ SchemaMismatchError = Class.new(StandardError)
53
+
54
+ # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
55
+ def find_and_cast_into_type(klass, data)
56
+ return if data.nil?
57
+
58
+ case klass.to_s
59
+ when 'Boolean'
60
+ return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
61
+ when 'Float'
62
+ return data if data.instance_of?(Float)
63
+ when 'Integer'
64
+ return data if data.instance_of?(Integer)
65
+ when 'Time'
66
+ return Time.parse(data)
67
+ when 'Date'
68
+ return Date.iso8601(data)
69
+ when 'String'
70
+ return data if data.instance_of?(String)
71
+ when 'Object' # "type: object"
72
+ return data if data.instance_of?(Hash)
73
+ when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
74
+ if data.instance_of?(Array)
75
+ sub_type = Regexp.last_match[:sub_type]
76
+ return data.map { |item| find_and_cast_into_type(sub_type, item) }
77
+ end
78
+ when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
79
+ if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
80
+ sub_type = Regexp.last_match[:sub_type]
81
+ return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
82
+ end
83
+ else # model
84
+ const = PDFGeneratorAPI.const_get(klass)
85
+ if const
86
+ if const.respond_to?(:openapi_any_of) # nested anyOf model
87
+ model = const.build(data)
88
+ return model if model
89
+ else
90
+ # raise if data contains keys that are not known to the model
91
+ raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
92
+ model = const.build_from_hash(data)
93
+ return model if model
94
+ end
95
+ end
96
+ end
97
+
98
+ raise # if no match by now, raise
99
+ rescue
100
+ raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
101
+ end
102
+ end
103
+ end
104
+
105
+ end