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,231 @@
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 TemplateDefinitionNewPagesInnerMargins
18
+ # Page or label margin from right
19
+ attr_accessor :right
20
+
21
+ # Page or label margin from bottom
22
+ attr_accessor :bottom
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'right' => :'right',
28
+ :'bottom' => :'bottom'
29
+ }
30
+ end
31
+
32
+ # Returns attribute mapping this model knows about
33
+ def self.acceptable_attribute_map
34
+ attribute_map
35
+ end
36
+
37
+ # Returns all the JSON keys this model knows about
38
+ def self.acceptable_attributes
39
+ acceptable_attribute_map.values
40
+ end
41
+
42
+ # Attribute type mapping.
43
+ def self.openapi_types
44
+ {
45
+ :'right' => :'Float',
46
+ :'bottom' => :'Float'
47
+ }
48
+ end
49
+
50
+ # List of attributes with nullable: true
51
+ def self.openapi_nullable
52
+ Set.new([
53
+ ])
54
+ end
55
+
56
+ # Initializes the object
57
+ # @param [Hash] attributes Model attributes in the form of hash
58
+ def initialize(attributes = {})
59
+ if (!attributes.is_a?(Hash))
60
+ fail ArgumentError, "The input argument (attributes) must be a hash in `PDFGeneratorAPI::TemplateDefinitionNewPagesInnerMargins` initialize method"
61
+ end
62
+
63
+ # check to see if the attribute exists and convert string to symbol for hash key
64
+ acceptable_attribute_map = self.class.acceptable_attribute_map
65
+ attributes = attributes.each_with_object({}) { |(k, v), h|
66
+ if (!acceptable_attribute_map.key?(k.to_sym))
67
+ fail ArgumentError, "`#{k}` is not a valid attribute in `PDFGeneratorAPI::TemplateDefinitionNewPagesInnerMargins`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
68
+ end
69
+ h[k.to_sym] = v
70
+ }
71
+
72
+ if attributes.key?(:'right')
73
+ self.right = attributes[:'right']
74
+ end
75
+
76
+ if attributes.key?(:'bottom')
77
+ self.bottom = attributes[:'bottom']
78
+ end
79
+ end
80
+
81
+ # Show invalid properties with the reasons. Usually used together with valid?
82
+ # @return Array for valid properties with the reasons
83
+ def list_invalid_properties
84
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
85
+ invalid_properties = Array.new
86
+ invalid_properties
87
+ end
88
+
89
+ # Check to see if the all the properties in the model are valid
90
+ # @return true if the model is valid
91
+ def valid?
92
+ warn '[DEPRECATED] the `valid?` method is obsolete'
93
+ true
94
+ end
95
+
96
+ # Checks equality by comparing each attribute.
97
+ # @param [Object] Object to be compared
98
+ def ==(o)
99
+ return true if self.equal?(o)
100
+ self.class == o.class &&
101
+ right == o.right &&
102
+ bottom == o.bottom
103
+ end
104
+
105
+ # @see the `==` method
106
+ # @param [Object] Object to be compared
107
+ def eql?(o)
108
+ self == o
109
+ end
110
+
111
+ # Calculates hash code according to all attributes.
112
+ # @return [Integer] Hash code
113
+ def hash
114
+ [right, bottom].hash
115
+ end
116
+
117
+ # Builds the object from hash
118
+ # @param [Hash] attributes Model attributes in the form of hash
119
+ # @return [Object] Returns the model itself
120
+ def self.build_from_hash(attributes)
121
+ return nil unless attributes.is_a?(Hash)
122
+ attributes = attributes.transform_keys(&:to_sym)
123
+ transformed_hash = {}
124
+ openapi_types.each_pair do |key, type|
125
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
126
+ transformed_hash["#{key}"] = nil
127
+ elsif type =~ /\AArray<(.*)>/i
128
+ # check to ensure the input is an array given that the attribute
129
+ # is documented as an array but the input is not
130
+ if attributes[attribute_map[key]].is_a?(Array)
131
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
132
+ end
133
+ elsif !attributes[attribute_map[key]].nil?
134
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
135
+ end
136
+ end
137
+ new(transformed_hash)
138
+ end
139
+
140
+ # Deserializes the data based on type
141
+ # @param string type Data type
142
+ # @param string value Value to be deserialized
143
+ # @return [Object] Deserialized data
144
+ def self._deserialize(type, value)
145
+ case type.to_sym
146
+ when :Time
147
+ Time.parse(value)
148
+ when :Date
149
+ Date.parse(value)
150
+ when :String
151
+ value.to_s
152
+ when :Integer
153
+ value.to_i
154
+ when :Float
155
+ value.to_f
156
+ when :Boolean
157
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
158
+ true
159
+ else
160
+ false
161
+ end
162
+ when :Object
163
+ # generic object (usually a Hash), return directly
164
+ value
165
+ when /\AArray<(?<inner_type>.+)>\z/
166
+ inner_type = Regexp.last_match[:inner_type]
167
+ value.map { |v| _deserialize(inner_type, v) }
168
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
169
+ k_type = Regexp.last_match[:k_type]
170
+ v_type = Regexp.last_match[:v_type]
171
+ {}.tap do |hash|
172
+ value.each do |k, v|
173
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
174
+ end
175
+ end
176
+ else # model
177
+ # models (e.g. Pet) or oneOf
178
+ klass = PDFGeneratorAPI.const_get(type)
179
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
180
+ end
181
+ end
182
+
183
+ # Returns the string representation of the object
184
+ # @return [String] String presentation of the object
185
+ def to_s
186
+ to_hash.to_s
187
+ end
188
+
189
+ # to_body is an alias to to_hash (backward compatibility)
190
+ # @return [Hash] Returns the object in the form of hash
191
+ def to_body
192
+ to_hash
193
+ end
194
+
195
+ # Returns the object in the form of hash
196
+ # @return [Hash] Returns the object in the form of hash
197
+ def to_hash
198
+ hash = {}
199
+ self.class.attribute_map.each_pair do |attr, param|
200
+ value = self.send(attr)
201
+ if value.nil?
202
+ is_nullable = self.class.openapi_nullable.include?(attr)
203
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
204
+ end
205
+
206
+ hash[param] = _to_hash(value)
207
+ end
208
+ hash
209
+ end
210
+
211
+ # Outputs non-array value in the form of hash
212
+ # For object, use to_hash. Otherwise, just return the value
213
+ # @param [Object] value Any valid value
214
+ # @return [Hash] Returns the value in the form of hash
215
+ def _to_hash(value)
216
+ if value.is_a?(Array)
217
+ value.compact.map { |v| _to_hash(v) }
218
+ elsif value.is_a?(Hash)
219
+ {}.tap do |hash|
220
+ value.each { |k, v| hash[k] = _to_hash(v) }
221
+ end
222
+ elsif value.respond_to? :to_hash
223
+ value.to_hash
224
+ else
225
+ value
226
+ end
227
+ end
228
+
229
+ end
230
+
231
+ end
@@ -0,0 +1,251 @@
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 TemplateDefinitionPagesInner
18
+ # Page width in units
19
+ attr_accessor :width
20
+
21
+ # Page height in units
22
+ attr_accessor :height
23
+
24
+ attr_accessor :margins
25
+
26
+ attr_accessor :components
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'width' => :'width',
32
+ :'height' => :'height',
33
+ :'margins' => :'margins',
34
+ :'components' => :'components'
35
+ }
36
+ end
37
+
38
+ # Returns attribute mapping this model knows about
39
+ def self.acceptable_attribute_map
40
+ attribute_map
41
+ end
42
+
43
+ # Returns all the JSON keys this model knows about
44
+ def self.acceptable_attributes
45
+ acceptable_attribute_map.values
46
+ end
47
+
48
+ # Attribute type mapping.
49
+ def self.openapi_types
50
+ {
51
+ :'width' => :'Float',
52
+ :'height' => :'Float',
53
+ :'margins' => :'TemplateDefinitionNewPagesInnerMargins',
54
+ :'components' => :'Array<Object>'
55
+ }
56
+ end
57
+
58
+ # List of attributes with nullable: true
59
+ def self.openapi_nullable
60
+ Set.new([
61
+ ])
62
+ end
63
+
64
+ # Initializes the object
65
+ # @param [Hash] attributes Model attributes in the form of hash
66
+ def initialize(attributes = {})
67
+ if (!attributes.is_a?(Hash))
68
+ fail ArgumentError, "The input argument (attributes) must be a hash in `PDFGeneratorAPI::TemplateDefinitionPagesInner` initialize method"
69
+ end
70
+
71
+ # check to see if the attribute exists and convert string to symbol for hash key
72
+ acceptable_attribute_map = self.class.acceptable_attribute_map
73
+ attributes = attributes.each_with_object({}) { |(k, v), h|
74
+ if (!acceptable_attribute_map.key?(k.to_sym))
75
+ fail ArgumentError, "`#{k}` is not a valid attribute in `PDFGeneratorAPI::TemplateDefinitionPagesInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
76
+ end
77
+ h[k.to_sym] = v
78
+ }
79
+
80
+ if attributes.key?(:'width')
81
+ self.width = attributes[:'width']
82
+ end
83
+
84
+ if attributes.key?(:'height')
85
+ self.height = attributes[:'height']
86
+ end
87
+
88
+ if attributes.key?(:'margins')
89
+ self.margins = attributes[:'margins']
90
+ end
91
+
92
+ if attributes.key?(:'components')
93
+ if (value = attributes[:'components']).is_a?(Array)
94
+ self.components = value
95
+ end
96
+ end
97
+ end
98
+
99
+ # Show invalid properties with the reasons. Usually used together with valid?
100
+ # @return Array for valid properties with the reasons
101
+ def list_invalid_properties
102
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
103
+ invalid_properties = Array.new
104
+ invalid_properties
105
+ end
106
+
107
+ # Check to see if the all the properties in the model are valid
108
+ # @return true if the model is valid
109
+ def valid?
110
+ warn '[DEPRECATED] the `valid?` method is obsolete'
111
+ true
112
+ end
113
+
114
+ # Checks equality by comparing each attribute.
115
+ # @param [Object] Object to be compared
116
+ def ==(o)
117
+ return true if self.equal?(o)
118
+ self.class == o.class &&
119
+ width == o.width &&
120
+ height == o.height &&
121
+ margins == o.margins &&
122
+ components == o.components
123
+ end
124
+
125
+ # @see the `==` method
126
+ # @param [Object] Object to be compared
127
+ def eql?(o)
128
+ self == o
129
+ end
130
+
131
+ # Calculates hash code according to all attributes.
132
+ # @return [Integer] Hash code
133
+ def hash
134
+ [width, height, margins, components].hash
135
+ end
136
+
137
+ # Builds the object from hash
138
+ # @param [Hash] attributes Model attributes in the form of hash
139
+ # @return [Object] Returns the model itself
140
+ def self.build_from_hash(attributes)
141
+ return nil unless attributes.is_a?(Hash)
142
+ attributes = attributes.transform_keys(&:to_sym)
143
+ transformed_hash = {}
144
+ openapi_types.each_pair do |key, type|
145
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
146
+ transformed_hash["#{key}"] = nil
147
+ elsif type =~ /\AArray<(.*)>/i
148
+ # check to ensure the input is an array given that the attribute
149
+ # is documented as an array but the input is not
150
+ if attributes[attribute_map[key]].is_a?(Array)
151
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
152
+ end
153
+ elsif !attributes[attribute_map[key]].nil?
154
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
155
+ end
156
+ end
157
+ new(transformed_hash)
158
+ end
159
+
160
+ # Deserializes the data based on type
161
+ # @param string type Data type
162
+ # @param string value Value to be deserialized
163
+ # @return [Object] Deserialized data
164
+ def self._deserialize(type, value)
165
+ case type.to_sym
166
+ when :Time
167
+ Time.parse(value)
168
+ when :Date
169
+ Date.parse(value)
170
+ when :String
171
+ value.to_s
172
+ when :Integer
173
+ value.to_i
174
+ when :Float
175
+ value.to_f
176
+ when :Boolean
177
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
178
+ true
179
+ else
180
+ false
181
+ end
182
+ when :Object
183
+ # generic object (usually a Hash), return directly
184
+ value
185
+ when /\AArray<(?<inner_type>.+)>\z/
186
+ inner_type = Regexp.last_match[:inner_type]
187
+ value.map { |v| _deserialize(inner_type, v) }
188
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
189
+ k_type = Regexp.last_match[:k_type]
190
+ v_type = Regexp.last_match[:v_type]
191
+ {}.tap do |hash|
192
+ value.each do |k, v|
193
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
194
+ end
195
+ end
196
+ else # model
197
+ # models (e.g. Pet) or oneOf
198
+ klass = PDFGeneratorAPI.const_get(type)
199
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
200
+ end
201
+ end
202
+
203
+ # Returns the string representation of the object
204
+ # @return [String] String presentation of the object
205
+ def to_s
206
+ to_hash.to_s
207
+ end
208
+
209
+ # to_body is an alias to to_hash (backward compatibility)
210
+ # @return [Hash] Returns the object in the form of hash
211
+ def to_body
212
+ to_hash
213
+ end
214
+
215
+ # Returns the object in the form of hash
216
+ # @return [Hash] Returns the object in the form of hash
217
+ def to_hash
218
+ hash = {}
219
+ self.class.attribute_map.each_pair do |attr, param|
220
+ value = self.send(attr)
221
+ if value.nil?
222
+ is_nullable = self.class.openapi_nullable.include?(attr)
223
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
224
+ end
225
+
226
+ hash[param] = _to_hash(value)
227
+ end
228
+ hash
229
+ end
230
+
231
+ # Outputs non-array value in the form of hash
232
+ # For object, use to_hash. Otherwise, just return the value
233
+ # @param [Object] value Any valid value
234
+ # @return [Hash] Returns the value in the form of hash
235
+ def _to_hash(value)
236
+ if value.is_a?(Array)
237
+ value.compact.map { |v| _to_hash(v) }
238
+ elsif value.is_a?(Hash)
239
+ {}.tap do |hash|
240
+ value.each { |k, v| hash[k] = _to_hash(v) }
241
+ end
242
+ elsif value.respond_to? :to_hash
243
+ value.to_hash
244
+ else
245
+ value
246
+ end
247
+ end
248
+
249
+ end
250
+
251
+ end