pdf_generator_api_client 8.0.26 → 8.0.28

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 (326) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -6
  3. data/docs/DocumentsApi.md +75 -1
  4. data/docs/GenerateViewerUrl200Response.md +20 -0
  5. data/docs/GenerateViewerUrl200ResponseMeta.md +22 -0
  6. data/docs/GenerateViewerUrlRequest.md +20 -0
  7. data/docs/PrefillParam.md +28 -0
  8. data/docs/StoreDocumentRequest.md +2 -0
  9. data/lib/pdf_generator_api_client/api/assets_api.rb +1 -1
  10. data/lib/pdf_generator_api_client/api/conversion_api.rb +1 -1
  11. data/lib/pdf_generator_api_client/api/documents_api.rb +72 -2
  12. data/lib/pdf_generator_api_client/api/e_invoices_api.rb +1 -1
  13. data/lib/pdf_generator_api_client/api/forms_api.rb +1 -1
  14. data/lib/pdf_generator_api_client/api/misc_api.rb +1 -1
  15. data/lib/pdf_generator_api_client/api/services_api.rb +1 -1
  16. data/lib/pdf_generator_api_client/api/template_library_api.rb +1 -1
  17. data/lib/pdf_generator_api_client/api/template_versions_api.rb +1 -1
  18. data/lib/pdf_generator_api_client/api/templates_api.rb +1 -1
  19. data/lib/pdf_generator_api_client/api/workspaces_api.rb +1 -1
  20. data/lib/pdf_generator_api_client/api_client.rb +1 -1
  21. data/lib/pdf_generator_api_client/api_error.rb +1 -1
  22. data/lib/pdf_generator_api_client/configuration.rb +1 -1
  23. data/lib/pdf_generator_api_client/models/accessibility_option.rb +1 -1
  24. data/lib/pdf_generator_api_client/models/add_watermark_request.rb +1 -1
  25. data/lib/pdf_generator_api_client/models/async_output_param.rb +1 -1
  26. data/lib/pdf_generator_api_client/models/callback_param.rb +1 -1
  27. data/lib/pdf_generator_api_client/models/component.rb +1 -1
  28. data/lib/pdf_generator_api_client/models/convert_html2_pdf_request.rb +1 -1
  29. data/lib/pdf_generator_api_client/models/convert_pdf2_image_request.rb +1 -1
  30. data/lib/pdf_generator_api_client/models/convert_url2_pdf_request.rb +1 -1
  31. data/lib/pdf_generator_api_client/models/copy_template_request.rb +1 -1
  32. data/lib/pdf_generator_api_client/models/create_e_invoice_request.rb +1 -1
  33. data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request.rb +1 -1
  34. data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request_template.rb +1 -1
  35. data/lib/pdf_generator_api_client/models/create_workspace_request.rb +1 -1
  36. data/lib/pdf_generator_api_client/models/data_batch_inner.rb +1 -1
  37. data/lib/pdf_generator_api_client/models/document.rb +1 -1
  38. data/lib/pdf_generator_api_client/models/document_action.rb +1 -1
  39. data/lib/pdf_generator_api_client/models/document_user.rb +1 -1
  40. data/lib/pdf_generator_api_client/models/document_version.rb +1 -1
  41. data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_base64.rb +1 -1
  42. data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_url.rb +1 -1
  43. data/lib/pdf_generator_api_client/models/encrypt_document_request.rb +1 -1
  44. data/lib/pdf_generator_api_client/models/extract_form_fields_request.rb +1 -1
  45. data/lib/pdf_generator_api_client/models/fill_form_fields_request.rb +1 -1
  46. data/lib/pdf_generator_api_client/models/form_action_download.rb +1 -1
  47. data/lib/pdf_generator_api_client/models/form_action_send.rb +1 -1
  48. data/lib/pdf_generator_api_client/models/form_action_send_send_document.rb +1 -1
  49. data/lib/pdf_generator_api_client/models/form_action_send_send_document_headers_inner.rb +1 -1
  50. data/lib/pdf_generator_api_client/models/form_action_store.rb +1 -1
  51. data/lib/pdf_generator_api_client/models/form_configuration.rb +1 -1
  52. data/lib/pdf_generator_api_client/models/form_configuration_new.rb +1 -1
  53. data/lib/pdf_generator_api_client/models/form_configuration_new_actions_inner.rb +1 -1
  54. data/lib/pdf_generator_api_client/models/form_fields_base64.rb +1 -1
  55. data/lib/pdf_generator_api_client/models/form_fields_inner.rb +1 -1
  56. data/lib/pdf_generator_api_client/models/form_fields_url.rb +1 -1
  57. data/lib/pdf_generator_api_client/models/form_fill_base64.rb +1 -1
  58. data/lib/pdf_generator_api_client/models/form_fill_url.rb +1 -1
  59. data/lib/pdf_generator_api_client/models/format_param.rb +1 -1
  60. data/lib/pdf_generator_api_client/models/generate_document_asynchronous_request.rb +1 -1
  61. data/lib/pdf_generator_api_client/models/generate_document_batch_asynchronous_request.rb +1 -1
  62. data/lib/pdf_generator_api_client/models/generate_document_batch_request.rb +1 -1
  63. data/lib/pdf_generator_api_client/models/generate_document_request.rb +1 -1
  64. data/lib/pdf_generator_api_client/models/generate_qr_code201_response.rb +1 -1
  65. data/lib/pdf_generator_api_client/models/generate_qr_code201_response_meta.rb +1 -1
  66. data/lib/pdf_generator_api_client/models/generate_qr_code_request.rb +1 -1
  67. data/lib/pdf_generator_api_client/models/generate_viewer_url200_response.rb +230 -0
  68. data/lib/pdf_generator_api_client/models/generate_viewer_url200_response_meta.rb +238 -0
  69. data/lib/pdf_generator_api_client/models/generate_viewer_url_request.rb +266 -0
  70. data/lib/pdf_generator_api_client/models/get_status200_response.rb +1 -1
  71. data/lib/pdf_generator_api_client/models/get_template_library200_response.rb +1 -1
  72. data/lib/pdf_generator_api_client/models/get_template_version422_response.rb +1 -1
  73. data/lib/pdf_generator_api_client/models/import_form_base64.rb +1 -1
  74. data/lib/pdf_generator_api_client/models/import_form_request.rb +1 -1
  75. data/lib/pdf_generator_api_client/models/import_form_url.rb +1 -1
  76. data/lib/pdf_generator_api_client/models/import_template_base64.rb +1 -1
  77. data/lib/pdf_generator_api_client/models/import_template_request.rb +1 -1
  78. data/lib/pdf_generator_api_client/models/import_template_url.rb +1 -1
  79. data/lib/pdf_generator_api_client/models/import_template_url_template.rb +1 -1
  80. data/lib/pdf_generator_api_client/models/inline_object.rb +1 -1
  81. data/lib/pdf_generator_api_client/models/inline_object1.rb +1 -1
  82. data/lib/pdf_generator_api_client/models/inline_object10.rb +1 -1
  83. data/lib/pdf_generator_api_client/models/inline_object10_meta.rb +1 -1
  84. data/lib/pdf_generator_api_client/models/inline_object11.rb +1 -1
  85. data/lib/pdf_generator_api_client/models/inline_object11_meta.rb +1 -1
  86. data/lib/pdf_generator_api_client/models/inline_object12.rb +1 -1
  87. data/lib/pdf_generator_api_client/models/inline_object12_meta.rb +1 -1
  88. data/lib/pdf_generator_api_client/models/inline_object12_meta_stats.rb +1 -1
  89. data/lib/pdf_generator_api_client/models/inline_object13.rb +1 -1
  90. data/lib/pdf_generator_api_client/models/inline_object14.rb +1 -1
  91. data/lib/pdf_generator_api_client/models/inline_object14_response_value.rb +1 -1
  92. data/lib/pdf_generator_api_client/models/inline_object14_response_value_default.rb +1 -1
  93. data/lib/pdf_generator_api_client/models/inline_object14_response_value_value.rb +1 -1
  94. data/lib/pdf_generator_api_client/models/inline_object15.rb +1 -1
  95. data/lib/pdf_generator_api_client/models/inline_object16.rb +1 -1
  96. data/lib/pdf_generator_api_client/models/inline_object17.rb +1 -1
  97. data/lib/pdf_generator_api_client/models/inline_object18.rb +1 -1
  98. data/lib/pdf_generator_api_client/models/inline_object19.rb +1 -1
  99. data/lib/pdf_generator_api_client/models/inline_object1_response.rb +1 -1
  100. data/lib/pdf_generator_api_client/models/inline_object2.rb +1 -1
  101. data/lib/pdf_generator_api_client/models/inline_object20.rb +1 -1
  102. data/lib/pdf_generator_api_client/models/inline_object20_meta.rb +1 -1
  103. data/lib/pdf_generator_api_client/models/inline_object21.rb +1 -1
  104. data/lib/pdf_generator_api_client/models/inline_object22.rb +1 -1
  105. data/lib/pdf_generator_api_client/models/inline_object22_response.rb +1 -1
  106. data/lib/pdf_generator_api_client/models/inline_object23.rb +1 -1
  107. data/lib/pdf_generator_api_client/models/inline_object24.rb +1 -1
  108. data/lib/pdf_generator_api_client/models/inline_object25.rb +1 -1
  109. data/lib/pdf_generator_api_client/models/inline_object26.rb +1 -1
  110. data/lib/pdf_generator_api_client/models/inline_object27.rb +1 -1
  111. data/lib/pdf_generator_api_client/models/inline_object28.rb +1 -1
  112. data/lib/pdf_generator_api_client/models/inline_object29.rb +1 -1
  113. data/lib/pdf_generator_api_client/models/inline_object3.rb +1 -1
  114. data/lib/pdf_generator_api_client/models/inline_object4.rb +1 -1
  115. data/lib/pdf_generator_api_client/models/inline_object5.rb +1 -1
  116. data/lib/pdf_generator_api_client/models/inline_object6.rb +1 -1
  117. data/lib/pdf_generator_api_client/models/inline_object7.rb +1 -1
  118. data/lib/pdf_generator_api_client/models/inline_object7_response.rb +1 -1
  119. data/lib/pdf_generator_api_client/models/inline_object8.rb +1 -1
  120. data/lib/pdf_generator_api_client/models/inline_object9.rb +1 -1
  121. data/lib/pdf_generator_api_client/models/inline_object9_meta.rb +1 -1
  122. data/lib/pdf_generator_api_client/models/inline_object_meta.rb +1 -1
  123. data/lib/pdf_generator_api_client/models/key_field_param.rb +1 -1
  124. data/lib/pdf_generator_api_client/models/make_accessible_base64.rb +1 -1
  125. data/lib/pdf_generator_api_client/models/make_accessible_request.rb +1 -1
  126. data/lib/pdf_generator_api_client/models/make_accessible_url.rb +1 -1
  127. data/lib/pdf_generator_api_client/models/metadata_param.rb +1 -1
  128. data/lib/pdf_generator_api_client/models/open_editor_request.rb +1 -1
  129. data/lib/pdf_generator_api_client/models/open_editor_request_data.rb +1 -1
  130. data/lib/pdf_generator_api_client/models/optimize_base64.rb +1 -1
  131. data/lib/pdf_generator_api_client/models/optimize_document_request.rb +1 -1
  132. data/lib/pdf_generator_api_client/models/optimize_url.rb +1 -1
  133. data/lib/pdf_generator_api_client/models/output_param.rb +1 -1
  134. data/lib/pdf_generator_api_client/models/pagination_meta.rb +1 -1
  135. data/lib/pdf_generator_api_client/models/prefill_param.rb +363 -0
  136. data/lib/pdf_generator_api_client/models/promote_template_version200_response.rb +1 -1
  137. data/lib/pdf_generator_api_client/models/public_template_library_item.rb +1 -1
  138. data/lib/pdf_generator_api_client/models/status_param.rb +1 -1
  139. data/lib/pdf_generator_api_client/models/store_document_request.rb +11 -2
  140. data/lib/pdf_generator_api_client/models/template.rb +1 -1
  141. data/lib/pdf_generator_api_client/models/template_definition.rb +1 -1
  142. data/lib/pdf_generator_api_client/models/template_definition_data_settings.rb +1 -1
  143. data/lib/pdf_generator_api_client/models/template_definition_editor.rb +1 -1
  144. data/lib/pdf_generator_api_client/models/template_definition_new.rb +1 -1
  145. data/lib/pdf_generator_api_client/models/template_definition_new_data_settings.rb +1 -1
  146. data/lib/pdf_generator_api_client/models/template_definition_new_editor.rb +1 -1
  147. data/lib/pdf_generator_api_client/models/template_definition_new_layout.rb +1 -1
  148. data/lib/pdf_generator_api_client/models/template_definition_new_layout_margins.rb +1 -1
  149. data/lib/pdf_generator_api_client/models/template_definition_new_layout_repeat_layout.rb +1 -1
  150. data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner.rb +1 -1
  151. data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner_margins.rb +1 -1
  152. data/lib/pdf_generator_api_client/models/template_definition_pages_inner.rb +1 -1
  153. data/lib/pdf_generator_api_client/models/template_param.rb +1 -1
  154. data/lib/pdf_generator_api_client/models/template_param_data.rb +1 -1
  155. data/lib/pdf_generator_api_client/models/template_param_id.rb +1 -1
  156. data/lib/pdf_generator_api_client/models/template_version.rb +1 -1
  157. data/lib/pdf_generator_api_client/models/template_version_collection.rb +1 -1
  158. data/lib/pdf_generator_api_client/models/template_version_collection_meta.rb +1 -1
  159. data/lib/pdf_generator_api_client/models/watermark_base64.rb +1 -1
  160. data/lib/pdf_generator_api_client/models/watermark_file_url_watermark.rb +1 -1
  161. data/lib/pdf_generator_api_client/models/watermark_image.rb +1 -1
  162. data/lib/pdf_generator_api_client/models/watermark_image_content_base64.rb +1 -1
  163. data/lib/pdf_generator_api_client/models/watermark_image_content_url.rb +1 -1
  164. data/lib/pdf_generator_api_client/models/watermark_position.rb +1 -1
  165. data/lib/pdf_generator_api_client/models/watermark_text.rb +1 -1
  166. data/lib/pdf_generator_api_client/models/workspace.rb +1 -1
  167. data/lib/pdf_generator_api_client/version.rb +2 -2
  168. data/lib/pdf_generator_api_client.rb +5 -1
  169. data/pdf_generator_api_client.gemspec +1 -1
  170. data/spec/api/assets_api_spec.rb +1 -1
  171. data/spec/api/conversion_api_spec.rb +1 -1
  172. data/spec/api/documents_api_spec.rb +14 -1
  173. data/spec/api/e_invoices_api_spec.rb +1 -1
  174. data/spec/api/forms_api_spec.rb +1 -1
  175. data/spec/api/misc_api_spec.rb +1 -1
  176. data/spec/api/services_api_spec.rb +1 -1
  177. data/spec/api/template_library_api_spec.rb +1 -1
  178. data/spec/api/template_versions_api_spec.rb +1 -1
  179. data/spec/api/templates_api_spec.rb +1 -1
  180. data/spec/api/workspaces_api_spec.rb +1 -1
  181. data/spec/models/accessibility_option_spec.rb +1 -1
  182. data/spec/models/add_watermark_request_spec.rb +1 -1
  183. data/spec/models/async_output_param_spec.rb +1 -1
  184. data/spec/models/callback_param_spec.rb +1 -1
  185. data/spec/models/component_spec.rb +1 -1
  186. data/spec/models/convert_html2_pdf_request_spec.rb +1 -1
  187. data/spec/models/convert_pdf2_image_request_spec.rb +1 -1
  188. data/spec/models/convert_url2_pdf_request_spec.rb +1 -1
  189. data/spec/models/copy_template_request_spec.rb +1 -1
  190. data/spec/models/create_e_invoice_request_spec.rb +1 -1
  191. data/spec/models/create_factur_xe_invoice_request_spec.rb +1 -1
  192. data/spec/models/create_factur_xe_invoice_request_template_spec.rb +1 -1
  193. data/spec/models/create_workspace_request_spec.rb +1 -1
  194. data/spec/models/data_batch_inner_spec.rb +1 -1
  195. data/spec/models/document_action_spec.rb +1 -1
  196. data/spec/models/document_spec.rb +1 -1
  197. data/spec/models/document_user_spec.rb +1 -1
  198. data/spec/models/document_version_spec.rb +1 -1
  199. data/spec/models/encrypt_and_decrypt_base64_spec.rb +1 -1
  200. data/spec/models/encrypt_and_decrypt_url_spec.rb +1 -1
  201. data/spec/models/encrypt_document_request_spec.rb +1 -1
  202. data/spec/models/extract_form_fields_request_spec.rb +1 -1
  203. data/spec/models/fill_form_fields_request_spec.rb +1 -1
  204. data/spec/models/form_action_download_spec.rb +1 -1
  205. data/spec/models/form_action_send_send_document_headers_inner_spec.rb +1 -1
  206. data/spec/models/form_action_send_send_document_spec.rb +1 -1
  207. data/spec/models/form_action_send_spec.rb +1 -1
  208. data/spec/models/form_action_store_spec.rb +1 -1
  209. data/spec/models/form_configuration_new_actions_inner_spec.rb +1 -1
  210. data/spec/models/form_configuration_new_spec.rb +1 -1
  211. data/spec/models/form_configuration_spec.rb +1 -1
  212. data/spec/models/form_fields_base64_spec.rb +1 -1
  213. data/spec/models/form_fields_inner_spec.rb +1 -1
  214. data/spec/models/form_fields_url_spec.rb +1 -1
  215. data/spec/models/form_fill_base64_spec.rb +1 -1
  216. data/spec/models/form_fill_url_spec.rb +1 -1
  217. data/spec/models/format_param_spec.rb +1 -1
  218. data/spec/models/generate_document_asynchronous_request_spec.rb +1 -1
  219. data/spec/models/generate_document_batch_asynchronous_request_spec.rb +1 -1
  220. data/spec/models/generate_document_batch_request_spec.rb +1 -1
  221. data/spec/models/generate_document_request_spec.rb +1 -1
  222. data/spec/models/generate_qr_code201_response_meta_spec.rb +1 -1
  223. data/spec/models/generate_qr_code201_response_spec.rb +1 -1
  224. data/spec/models/generate_qr_code_request_spec.rb +1 -1
  225. data/spec/models/generate_viewer_url200_response_meta_spec.rb +48 -0
  226. data/spec/models/generate_viewer_url200_response_spec.rb +42 -0
  227. data/spec/models/generate_viewer_url_request_spec.rb +46 -0
  228. data/spec/models/get_status200_response_spec.rb +1 -1
  229. data/spec/models/get_template_library200_response_spec.rb +1 -1
  230. data/spec/models/get_template_version422_response_spec.rb +1 -1
  231. data/spec/models/import_form_base64_spec.rb +1 -1
  232. data/spec/models/import_form_request_spec.rb +1 -1
  233. data/spec/models/import_form_url_spec.rb +1 -1
  234. data/spec/models/import_template_base64_spec.rb +1 -1
  235. data/spec/models/import_template_request_spec.rb +1 -1
  236. data/spec/models/import_template_url_spec.rb +1 -1
  237. data/spec/models/import_template_url_template_spec.rb +1 -1
  238. data/spec/models/inline_object10_meta_spec.rb +1 -1
  239. data/spec/models/inline_object10_spec.rb +1 -1
  240. data/spec/models/inline_object11_meta_spec.rb +1 -1
  241. data/spec/models/inline_object11_spec.rb +1 -1
  242. data/spec/models/inline_object12_meta_spec.rb +1 -1
  243. data/spec/models/inline_object12_meta_stats_spec.rb +1 -1
  244. data/spec/models/inline_object12_spec.rb +1 -1
  245. data/spec/models/inline_object13_spec.rb +1 -1
  246. data/spec/models/inline_object14_response_value_default_spec.rb +1 -1
  247. data/spec/models/inline_object14_response_value_spec.rb +1 -1
  248. data/spec/models/inline_object14_response_value_value_spec.rb +1 -1
  249. data/spec/models/inline_object14_spec.rb +1 -1
  250. data/spec/models/inline_object15_spec.rb +1 -1
  251. data/spec/models/inline_object16_spec.rb +1 -1
  252. data/spec/models/inline_object17_spec.rb +1 -1
  253. data/spec/models/inline_object18_spec.rb +1 -1
  254. data/spec/models/inline_object19_spec.rb +1 -1
  255. data/spec/models/inline_object1_response_spec.rb +1 -1
  256. data/spec/models/inline_object1_spec.rb +1 -1
  257. data/spec/models/inline_object20_meta_spec.rb +1 -1
  258. data/spec/models/inline_object20_spec.rb +1 -1
  259. data/spec/models/inline_object21_spec.rb +1 -1
  260. data/spec/models/inline_object22_response_spec.rb +1 -1
  261. data/spec/models/inline_object22_spec.rb +1 -1
  262. data/spec/models/inline_object23_spec.rb +1 -1
  263. data/spec/models/inline_object24_spec.rb +1 -1
  264. data/spec/models/inline_object25_spec.rb +1 -1
  265. data/spec/models/inline_object26_spec.rb +1 -1
  266. data/spec/models/inline_object27_spec.rb +1 -1
  267. data/spec/models/inline_object28_spec.rb +1 -1
  268. data/spec/models/inline_object29_spec.rb +1 -1
  269. data/spec/models/inline_object2_spec.rb +1 -1
  270. data/spec/models/inline_object3_spec.rb +1 -1
  271. data/spec/models/inline_object4_spec.rb +1 -1
  272. data/spec/models/inline_object5_spec.rb +1 -1
  273. data/spec/models/inline_object6_spec.rb +1 -1
  274. data/spec/models/inline_object7_response_spec.rb +1 -1
  275. data/spec/models/inline_object7_spec.rb +1 -1
  276. data/spec/models/inline_object8_spec.rb +1 -1
  277. data/spec/models/inline_object9_meta_spec.rb +1 -1
  278. data/spec/models/inline_object9_spec.rb +1 -1
  279. data/spec/models/inline_object_meta_spec.rb +1 -1
  280. data/spec/models/inline_object_spec.rb +1 -1
  281. data/spec/models/key_field_param_spec.rb +1 -1
  282. data/spec/models/make_accessible_base64_spec.rb +1 -1
  283. data/spec/models/make_accessible_request_spec.rb +1 -1
  284. data/spec/models/make_accessible_url_spec.rb +1 -1
  285. data/spec/models/metadata_param_spec.rb +1 -1
  286. data/spec/models/open_editor_request_data_spec.rb +1 -1
  287. data/spec/models/open_editor_request_spec.rb +1 -1
  288. data/spec/models/optimize_base64_spec.rb +1 -1
  289. data/spec/models/optimize_document_request_spec.rb +1 -1
  290. data/spec/models/optimize_url_spec.rb +1 -1
  291. data/spec/models/output_param_spec.rb +1 -1
  292. data/spec/models/pagination_meta_spec.rb +1 -1
  293. data/spec/models/prefill_param_spec.rb +66 -0
  294. data/spec/models/promote_template_version200_response_spec.rb +1 -1
  295. data/spec/models/public_template_library_item_spec.rb +1 -1
  296. data/spec/models/status_param_spec.rb +1 -1
  297. data/spec/models/store_document_request_spec.rb +7 -1
  298. data/spec/models/template_definition_data_settings_spec.rb +1 -1
  299. data/spec/models/template_definition_editor_spec.rb +1 -1
  300. data/spec/models/template_definition_new_data_settings_spec.rb +1 -1
  301. data/spec/models/template_definition_new_editor_spec.rb +1 -1
  302. data/spec/models/template_definition_new_layout_margins_spec.rb +1 -1
  303. data/spec/models/template_definition_new_layout_repeat_layout_spec.rb +1 -1
  304. data/spec/models/template_definition_new_layout_spec.rb +1 -1
  305. data/spec/models/template_definition_new_pages_inner_margins_spec.rb +1 -1
  306. data/spec/models/template_definition_new_pages_inner_spec.rb +1 -1
  307. data/spec/models/template_definition_new_spec.rb +1 -1
  308. data/spec/models/template_definition_pages_inner_spec.rb +1 -1
  309. data/spec/models/template_definition_spec.rb +1 -1
  310. data/spec/models/template_param_data_spec.rb +1 -1
  311. data/spec/models/template_param_id_spec.rb +1 -1
  312. data/spec/models/template_param_spec.rb +1 -1
  313. data/spec/models/template_spec.rb +1 -1
  314. data/spec/models/template_version_collection_meta_spec.rb +1 -1
  315. data/spec/models/template_version_collection_spec.rb +1 -1
  316. data/spec/models/template_version_spec.rb +1 -1
  317. data/spec/models/watermark_base64_spec.rb +1 -1
  318. data/spec/models/watermark_file_url_watermark_spec.rb +1 -1
  319. data/spec/models/watermark_image_content_base64_spec.rb +1 -1
  320. data/spec/models/watermark_image_content_url_spec.rb +1 -1
  321. data/spec/models/watermark_image_spec.rb +1 -1
  322. data/spec/models/watermark_position_spec.rb +1 -1
  323. data/spec/models/watermark_text_spec.rb +1 -1
  324. data/spec/models/workspace_spec.rb +1 -1
  325. data/spec/spec_helper.rb +1 -1
  326. metadata +146 -130
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 4.0.26
6
+ The version of the OpenAPI document: 4.0.28
7
7
  Contact: support@pdfgeneratorapi.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 4.0.26
6
+ The version of the OpenAPI document: 4.0.28
7
7
  Contact: support@pdfgeneratorapi.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -0,0 +1,363 @@
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.28
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
+ # Viewer prefill data, encrypted into the viewer URL. Only applied when `output` is `viewer`.
18
+ class PrefillParam
19
+ attr_accessor :id_code
20
+
21
+ attr_accessor :first_name
22
+
23
+ attr_accessor :last_name
24
+
25
+ attr_accessor :email
26
+
27
+ attr_accessor :signature_id
28
+
29
+ attr_accessor :editable
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+ :'id_code' => :'id_code',
35
+ :'first_name' => :'first_name',
36
+ :'last_name' => :'last_name',
37
+ :'email' => :'email',
38
+ :'signature_id' => :'signature_id',
39
+ :'editable' => :'editable'
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
+ :'id_code' => :'String',
57
+ :'first_name' => :'String',
58
+ :'last_name' => :'String',
59
+ :'email' => :'String',
60
+ :'signature_id' => :'String',
61
+ :'editable' => :'Boolean'
62
+ }
63
+ end
64
+
65
+ # List of attributes with nullable: true
66
+ def self.openapi_nullable
67
+ Set.new([
68
+ ])
69
+ end
70
+
71
+ # Initializes the object
72
+ # @param [Hash] attributes Model attributes in the form of hash
73
+ def initialize(attributes = {})
74
+ if (!attributes.is_a?(Hash))
75
+ fail ArgumentError, "The input argument (attributes) must be a hash in `PDFGeneratorAPI::PrefillParam` initialize method"
76
+ end
77
+
78
+ # check to see if the attribute exists and convert string to symbol for hash key
79
+ acceptable_attribute_map = self.class.acceptable_attribute_map
80
+ attributes = attributes.each_with_object({}) { |(k, v), h|
81
+ if (!acceptable_attribute_map.key?(k.to_sym))
82
+ fail ArgumentError, "`#{k}` is not a valid attribute in `PDFGeneratorAPI::PrefillParam`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
83
+ end
84
+ h[k.to_sym] = v
85
+ }
86
+
87
+ if attributes.key?(:'id_code')
88
+ self.id_code = attributes[:'id_code']
89
+ end
90
+
91
+ if attributes.key?(:'first_name')
92
+ self.first_name = attributes[:'first_name']
93
+ end
94
+
95
+ if attributes.key?(:'last_name')
96
+ self.last_name = attributes[:'last_name']
97
+ end
98
+
99
+ if attributes.key?(:'email')
100
+ self.email = attributes[:'email']
101
+ end
102
+
103
+ if attributes.key?(:'signature_id')
104
+ self.signature_id = attributes[:'signature_id']
105
+ end
106
+
107
+ if attributes.key?(:'editable')
108
+ self.editable = attributes[:'editable']
109
+ else
110
+ self.editable = true
111
+ end
112
+ end
113
+
114
+ # Show invalid properties with the reasons. Usually used together with valid?
115
+ # @return Array for valid properties with the reasons
116
+ def list_invalid_properties
117
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
118
+ invalid_properties = Array.new
119
+ if !@id_code.nil? && @id_code.to_s.length > 128
120
+ invalid_properties.push('invalid value for "id_code", the character length must be smaller than or equal to 128.')
121
+ end
122
+
123
+ if !@first_name.nil? && @first_name.to_s.length > 128
124
+ invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 128.')
125
+ end
126
+
127
+ if !@last_name.nil? && @last_name.to_s.length > 128
128
+ invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 128.')
129
+ end
130
+
131
+ if !@email.nil? && @email.to_s.length > 120
132
+ invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 120.')
133
+ end
134
+
135
+ if !@signature_id.nil? && @signature_id.to_s.length > 128
136
+ invalid_properties.push('invalid value for "signature_id", the character length must be smaller than or equal to 128.')
137
+ end
138
+
139
+ invalid_properties
140
+ end
141
+
142
+ # Check to see if the all the properties in the model are valid
143
+ # @return true if the model is valid
144
+ def valid?
145
+ warn '[DEPRECATED] the `valid?` method is obsolete'
146
+ return false if !@id_code.nil? && @id_code.to_s.length > 128
147
+ return false if !@first_name.nil? && @first_name.to_s.length > 128
148
+ return false if !@last_name.nil? && @last_name.to_s.length > 128
149
+ return false if !@email.nil? && @email.to_s.length > 120
150
+ return false if !@signature_id.nil? && @signature_id.to_s.length > 128
151
+ true
152
+ end
153
+
154
+ # Custom attribute writer method with validation
155
+ # @param [Object] id_code Value to be assigned
156
+ def id_code=(id_code)
157
+ if id_code.nil?
158
+ fail ArgumentError, 'id_code cannot be nil'
159
+ end
160
+
161
+ if id_code.to_s.length > 128
162
+ fail ArgumentError, 'invalid value for "id_code", the character length must be smaller than or equal to 128.'
163
+ end
164
+
165
+ @id_code = id_code
166
+ end
167
+
168
+ # Custom attribute writer method with validation
169
+ # @param [Object] first_name Value to be assigned
170
+ def first_name=(first_name)
171
+ if first_name.nil?
172
+ fail ArgumentError, 'first_name cannot be nil'
173
+ end
174
+
175
+ if first_name.to_s.length > 128
176
+ fail ArgumentError, 'invalid value for "first_name", the character length must be smaller than or equal to 128.'
177
+ end
178
+
179
+ @first_name = first_name
180
+ end
181
+
182
+ # Custom attribute writer method with validation
183
+ # @param [Object] last_name Value to be assigned
184
+ def last_name=(last_name)
185
+ if last_name.nil?
186
+ fail ArgumentError, 'last_name cannot be nil'
187
+ end
188
+
189
+ if last_name.to_s.length > 128
190
+ fail ArgumentError, 'invalid value for "last_name", the character length must be smaller than or equal to 128.'
191
+ end
192
+
193
+ @last_name = last_name
194
+ end
195
+
196
+ # Custom attribute writer method with validation
197
+ # @param [Object] email Value to be assigned
198
+ def email=(email)
199
+ if email.nil?
200
+ fail ArgumentError, 'email cannot be nil'
201
+ end
202
+
203
+ if email.to_s.length > 120
204
+ fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 120.'
205
+ end
206
+
207
+ @email = email
208
+ end
209
+
210
+ # Custom attribute writer method with validation
211
+ # @param [Object] signature_id Value to be assigned
212
+ def signature_id=(signature_id)
213
+ if signature_id.nil?
214
+ fail ArgumentError, 'signature_id cannot be nil'
215
+ end
216
+
217
+ if signature_id.to_s.length > 128
218
+ fail ArgumentError, 'invalid value for "signature_id", the character length must be smaller than or equal to 128.'
219
+ end
220
+
221
+ @signature_id = signature_id
222
+ end
223
+
224
+ # Checks equality by comparing each attribute.
225
+ # @param [Object] Object to be compared
226
+ def ==(o)
227
+ return true if self.equal?(o)
228
+ self.class == o.class &&
229
+ id_code == o.id_code &&
230
+ first_name == o.first_name &&
231
+ last_name == o.last_name &&
232
+ email == o.email &&
233
+ signature_id == o.signature_id &&
234
+ editable == o.editable
235
+ end
236
+
237
+ # @see the `==` method
238
+ # @param [Object] Object to be compared
239
+ def eql?(o)
240
+ self == o
241
+ end
242
+
243
+ # Calculates hash code according to all attributes.
244
+ # @return [Integer] Hash code
245
+ def hash
246
+ [id_code, first_name, last_name, email, signature_id, editable].hash
247
+ end
248
+
249
+ # Builds the object from hash
250
+ # @param [Hash] attributes Model attributes in the form of hash
251
+ # @return [Object] Returns the model itself
252
+ def self.build_from_hash(attributes)
253
+ return nil unless attributes.is_a?(Hash)
254
+ attributes = attributes.transform_keys(&:to_sym)
255
+ transformed_hash = {}
256
+ openapi_types.each_pair do |key, type|
257
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
258
+ transformed_hash["#{key}"] = nil
259
+ elsif type =~ /\AArray<(.*)>/i
260
+ # check to ensure the input is an array given that the attribute
261
+ # is documented as an array but the input is not
262
+ if attributes[attribute_map[key]].is_a?(Array)
263
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
264
+ end
265
+ elsif !attributes[attribute_map[key]].nil?
266
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
267
+ end
268
+ end
269
+ new(transformed_hash)
270
+ end
271
+
272
+ # Deserializes the data based on type
273
+ # @param string type Data type
274
+ # @param string value Value to be deserialized
275
+ # @return [Object] Deserialized data
276
+ def self._deserialize(type, value)
277
+ case type.to_sym
278
+ when :Time
279
+ Time.parse(value)
280
+ when :Date
281
+ Date.parse(value)
282
+ when :String
283
+ value.to_s
284
+ when :Integer
285
+ value.to_i
286
+ when :Float
287
+ value.to_f
288
+ when :Boolean
289
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
290
+ true
291
+ else
292
+ false
293
+ end
294
+ when :Object
295
+ # generic object (usually a Hash), return directly
296
+ value
297
+ when /\AArray<(?<inner_type>.+)>\z/
298
+ inner_type = Regexp.last_match[:inner_type]
299
+ value.map { |v| _deserialize(inner_type, v) }
300
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
301
+ k_type = Regexp.last_match[:k_type]
302
+ v_type = Regexp.last_match[:v_type]
303
+ {}.tap do |hash|
304
+ value.each do |k, v|
305
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
306
+ end
307
+ end
308
+ else # model
309
+ # models (e.g. Pet) or oneOf
310
+ klass = PDFGeneratorAPI.const_get(type)
311
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
312
+ end
313
+ end
314
+
315
+ # Returns the string representation of the object
316
+ # @return [String] String presentation of the object
317
+ def to_s
318
+ to_hash.to_s
319
+ end
320
+
321
+ # to_body is an alias to to_hash (backward compatibility)
322
+ # @return [Hash] Returns the object in the form of hash
323
+ def to_body
324
+ to_hash
325
+ end
326
+
327
+ # Returns the object in the form of hash
328
+ # @return [Hash] Returns the object in the form of hash
329
+ def to_hash
330
+ hash = {}
331
+ self.class.attribute_map.each_pair do |attr, param|
332
+ value = self.send(attr)
333
+ if value.nil?
334
+ is_nullable = self.class.openapi_nullable.include?(attr)
335
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
336
+ end
337
+
338
+ hash[param] = _to_hash(value)
339
+ end
340
+ hash
341
+ end
342
+
343
+ # Outputs non-array value in the form of hash
344
+ # For object, use to_hash. Otherwise, just return the value
345
+ # @param [Object] value Any valid value
346
+ # @return [Hash] Returns the value in the form of hash
347
+ def _to_hash(value)
348
+ if value.is_a?(Array)
349
+ value.compact.map { |v| _to_hash(v) }
350
+ elsif value.is_a?(Hash)
351
+ {}.tap do |hash|
352
+ value.each { |k, v| hash[k] = _to_hash(v) }
353
+ end
354
+ elsif value.respond_to? :to_hash
355
+ value.to_hash
356
+ else
357
+ value
358
+ end
359
+ end
360
+
361
+ end
362
+
363
+ end
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 4.0.26
6
+ The version of the OpenAPI document: 4.0.28
7
7
  Contact: support@pdfgeneratorapi.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 4.0.26
6
+ The version of the OpenAPI document: 4.0.28
7
7
  Contact: support@pdfgeneratorapi.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 4.0.26
6
+ The version of the OpenAPI document: 4.0.28
7
7
  Contact: support@pdfgeneratorapi.com
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0