pdf_generator_api_client 4.0.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (451) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +519 -0
  4. data/Rakefile +10 -0
  5. data/docs/AccessibilityOption.md +15 -0
  6. data/docs/AddWatermarkRequest.md +49 -0
  7. data/docs/AssetsApi.md +77 -0
  8. data/docs/AsyncOutputParam.md +15 -0
  9. data/docs/CallbackParam.md +20 -0
  10. data/docs/Component.md +34 -0
  11. data/docs/ConversionApi.md +217 -0
  12. data/docs/ConvertHTML2PDFRequest.md +26 -0
  13. data/docs/ConvertPDF2ImageRequest.md +32 -0
  14. data/docs/ConvertURL2PDFRequest.md +26 -0
  15. data/docs/CopyTemplateRequest.md +18 -0
  16. data/docs/CreateEInvoiceRequest.md +22 -0
  17. data/docs/CreateFacturXEInvoiceRequest.md +26 -0
  18. data/docs/CreateFacturXEInvoiceRequestTemplate.md +22 -0
  19. data/docs/CreateWorkspaceRequest.md +18 -0
  20. data/docs/DataBatchInner.md +20 -0
  21. data/docs/Document.md +26 -0
  22. data/docs/DocumentsApi.md +646 -0
  23. data/docs/EInvoicesApi.md +284 -0
  24. data/docs/EncryptAndDecryptBase64.md +26 -0
  25. data/docs/EncryptAndDecryptUrl.md +26 -0
  26. data/docs/EncryptDocumentRequest.md +49 -0
  27. data/docs/ExtractFormFieldsRequest.md +49 -0
  28. data/docs/FillFormFieldsRequest.md +49 -0
  29. data/docs/FormActionDownload.md +18 -0
  30. data/docs/FormActionSend.md +18 -0
  31. data/docs/FormActionSendSendDocument.md +20 -0
  32. data/docs/FormActionSendSendDocumentHeadersInner.md +20 -0
  33. data/docs/FormActionStore.md +18 -0
  34. data/docs/FormConfiguration.md +22 -0
  35. data/docs/FormConfigurationNew.md +26 -0
  36. data/docs/FormConfigurationNewActionsInner.md +22 -0
  37. data/docs/FormFieldsBase64.md +20 -0
  38. data/docs/FormFieldsInner.md +24 -0
  39. data/docs/FormFieldsUrl.md +20 -0
  40. data/docs/FormFillBase64.md +24 -0
  41. data/docs/FormFillUrl.md +24 -0
  42. data/docs/FormatParam.md +15 -0
  43. data/docs/FormsApi.md +639 -0
  44. data/docs/GenerateDocumentAsynchronousRequest.md +32 -0
  45. data/docs/GenerateDocumentBatchAsynchronousRequest.md +30 -0
  46. data/docs/GenerateDocumentBatchRequest.md +28 -0
  47. data/docs/GenerateDocumentRequest.md +30 -0
  48. data/docs/GenerateQRCode201Response.md +20 -0
  49. data/docs/GenerateQRCode201ResponseMeta.md +20 -0
  50. data/docs/GenerateQRCodeRequest.md +26 -0
  51. data/docs/GetStatus200Response.md +28 -0
  52. data/docs/GetTemplateLibrary200Response.md +18 -0
  53. data/docs/GetTemplateVersion422Response.md +18 -0
  54. data/docs/ImportFormBase64.md +20 -0
  55. data/docs/ImportFormRequest.md +49 -0
  56. data/docs/ImportFormUrl.md +20 -0
  57. data/docs/ImportTemplateBase64.md +20 -0
  58. data/docs/ImportTemplateRequest.md +49 -0
  59. data/docs/ImportTemplateUrl.md +20 -0
  60. data/docs/ImportTemplateUrlTemplate.md +18 -0
  61. data/docs/InlineObject.md +20 -0
  62. data/docs/InlineObject1.md +18 -0
  63. data/docs/InlineObject10.md +20 -0
  64. data/docs/InlineObject10Meta.md +24 -0
  65. data/docs/InlineObject11.md +20 -0
  66. data/docs/InlineObject11Meta.md +26 -0
  67. data/docs/InlineObject12.md +20 -0
  68. data/docs/InlineObject12Meta.md +28 -0
  69. data/docs/InlineObject12MetaStats.md +20 -0
  70. data/docs/InlineObject13.md +20 -0
  71. data/docs/InlineObject14.md +18 -0
  72. data/docs/InlineObject14ResponseValue.md +46 -0
  73. data/docs/InlineObject14ResponseValueDefault.md +51 -0
  74. data/docs/InlineObject14ResponseValueValue.md +51 -0
  75. data/docs/InlineObject15.md +20 -0
  76. data/docs/InlineObject16.md +20 -0
  77. data/docs/InlineObject17.md +18 -0
  78. data/docs/InlineObject18.md +20 -0
  79. data/docs/InlineObject18Meta.md +18 -0
  80. data/docs/InlineObject19.md +18 -0
  81. data/docs/InlineObject1Response.md +18 -0
  82. data/docs/InlineObject2.md +18 -0
  83. data/docs/InlineObject20.md +18 -0
  84. data/docs/InlineObject20Response.md +18 -0
  85. data/docs/InlineObject21.md +18 -0
  86. data/docs/InlineObject22.md +18 -0
  87. data/docs/InlineObject23.md +18 -0
  88. data/docs/InlineObject24.md +18 -0
  89. data/docs/InlineObject25.md +20 -0
  90. data/docs/InlineObject26.md +18 -0
  91. data/docs/InlineObject27.md +18 -0
  92. data/docs/InlineObject3.md +18 -0
  93. data/docs/InlineObject4.md +20 -0
  94. data/docs/InlineObject5.md +20 -0
  95. data/docs/InlineObject6.md +20 -0
  96. data/docs/InlineObject7.md +18 -0
  97. data/docs/InlineObject7Response.md +18 -0
  98. data/docs/InlineObject8.md +18 -0
  99. data/docs/InlineObject9.md +20 -0
  100. data/docs/InlineObject9Meta.md +26 -0
  101. data/docs/InlineObjectMeta.md +20 -0
  102. data/docs/KeyFieldParam.md +15 -0
  103. data/docs/MakeAccessibleBase64.md +26 -0
  104. data/docs/MakeAccessibleRequest.md +49 -0
  105. data/docs/MakeAccessibleUrl.md +26 -0
  106. data/docs/MetadataParam.md +20 -0
  107. data/docs/MiscApi.md +74 -0
  108. data/docs/OpenEditorRequest.md +20 -0
  109. data/docs/OpenEditorRequestData.md +49 -0
  110. data/docs/OptimizeBase64.md +22 -0
  111. data/docs/OptimizeDocumentRequest.md +49 -0
  112. data/docs/OptimizeUrl.md +22 -0
  113. data/docs/OutputParam.md +15 -0
  114. data/docs/PaginationMeta.md +22 -0
  115. data/docs/PromoteTemplateVersion200Response.md +18 -0
  116. data/docs/PublicTemplateLibraryItem.md +26 -0
  117. data/docs/ServicesApi.md +497 -0
  118. data/docs/StatusParam.md +15 -0
  119. data/docs/StoreDocumentRequest.md +24 -0
  120. data/docs/Template.md +28 -0
  121. data/docs/TemplateDefinition.md +32 -0
  122. data/docs/TemplateDefinitionDataSettings.md +20 -0
  123. data/docs/TemplateDefinitionEditor.md +18 -0
  124. data/docs/TemplateDefinitionNew.md +34 -0
  125. data/docs/TemplateDefinitionNewDataSettings.md +22 -0
  126. data/docs/TemplateDefinitionNewEditor.md +18 -0
  127. data/docs/TemplateDefinitionNewLayout.md +34 -0
  128. data/docs/TemplateDefinitionNewLayoutMargins.md +24 -0
  129. data/docs/TemplateDefinitionNewLayoutRepeatLayout.md +22 -0
  130. data/docs/TemplateDefinitionNewPagesInner.md +32 -0
  131. data/docs/TemplateDefinitionNewPagesInnerMargins.md +20 -0
  132. data/docs/TemplateDefinitionPagesInner.md +24 -0
  133. data/docs/TemplateLibraryApi.md +139 -0
  134. data/docs/TemplateParam.md +22 -0
  135. data/docs/TemplateParamData.md +49 -0
  136. data/docs/TemplateParamId.md +49 -0
  137. data/docs/TemplateVersion.md +36 -0
  138. data/docs/TemplateVersionCollection.md +20 -0
  139. data/docs/TemplateVersionCollectionMeta.md +22 -0
  140. data/docs/TemplateVersionsApi.md +298 -0
  141. data/docs/TemplatesApi.md +791 -0
  142. data/docs/WatermarkBase64.md +24 -0
  143. data/docs/WatermarkFileUrlWatermark.md +20 -0
  144. data/docs/WatermarkImage.md +26 -0
  145. data/docs/WatermarkImageContentBase64.md +24 -0
  146. data/docs/WatermarkImageContentUrl.md +24 -0
  147. data/docs/WatermarkPosition.md +15 -0
  148. data/docs/WatermarkText.md +28 -0
  149. data/docs/Workspace.md +24 -0
  150. data/docs/WorkspacesApi.md +292 -0
  151. data/git_push.sh +57 -0
  152. data/lib/pdf_generator_api_client/api/assets_api.rb +90 -0
  153. data/lib/pdf_generator_api_client/api/conversion_api.rb +226 -0
  154. data/lib/pdf_generator_api_client/api/documents_api.rb +623 -0
  155. data/lib/pdf_generator_api_client/api/e_invoices_api.rb +283 -0
  156. data/lib/pdf_generator_api_client/api/forms_api.rb +604 -0
  157. data/lib/pdf_generator_api_client/api/misc_api.rb +79 -0
  158. data/lib/pdf_generator_api_client/api/services_api.rb +498 -0
  159. data/lib/pdf_generator_api_client/api/template_library_api.rb +145 -0
  160. data/lib/pdf_generator_api_client/api/template_versions_api.rb +298 -0
  161. data/lib/pdf_generator_api_client/api/templates_api.rb +766 -0
  162. data/lib/pdf_generator_api_client/api/workspaces_api.rb +275 -0
  163. data/lib/pdf_generator_api_client/api_client.rb +393 -0
  164. data/lib/pdf_generator_api_client/api_error.rb +58 -0
  165. data/lib/pdf_generator_api_client/configuration.rb +309 -0
  166. data/lib/pdf_generator_api_client/models/accessibility_option.rb +47 -0
  167. data/lib/pdf_generator_api_client/models/add_watermark_request.rb +105 -0
  168. data/lib/pdf_generator_api_client/models/async_output_param.rb +41 -0
  169. data/lib/pdf_generator_api_client/models/callback_param.rb +232 -0
  170. data/lib/pdf_generator_api_client/models/component.rb +336 -0
  171. data/lib/pdf_generator_api_client/models/convert_html2_pdf_request.rb +324 -0
  172. data/lib/pdf_generator_api_client/models/convert_pdf2_image_request.rb +422 -0
  173. data/lib/pdf_generator_api_client/models/convert_url2_pdf_request.rb +324 -0
  174. data/lib/pdf_generator_api_client/models/copy_template_request.rb +221 -0
  175. data/lib/pdf_generator_api_client/models/create_e_invoice_request.rb +308 -0
  176. data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request.rb +315 -0
  177. data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request_template.rb +242 -0
  178. data/lib/pdf_generator_api_client/models/create_workspace_request.rb +221 -0
  179. data/lib/pdf_generator_api_client/models/data_batch_inner.rb +231 -0
  180. data/lib/pdf_generator_api_client/models/document.rb +261 -0
  181. data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_base64.rb +331 -0
  182. data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_url.rb +331 -0
  183. data/lib/pdf_generator_api_client/models/encrypt_document_request.rb +105 -0
  184. data/lib/pdf_generator_api_client/models/extract_form_fields_request.rb +105 -0
  185. data/lib/pdf_generator_api_client/models/fill_form_fields_request.rb +105 -0
  186. data/lib/pdf_generator_api_client/models/form_action_download.rb +221 -0
  187. data/lib/pdf_generator_api_client/models/form_action_send.rb +221 -0
  188. data/lib/pdf_generator_api_client/models/form_action_send_send_document.rb +250 -0
  189. data/lib/pdf_generator_api_client/models/form_action_send_send_document_headers_inner.rb +283 -0
  190. data/lib/pdf_generator_api_client/models/form_action_store.rb +221 -0
  191. data/lib/pdf_generator_api_client/models/form_configuration.rb +290 -0
  192. data/lib/pdf_generator_api_client/models/form_configuration_new.rb +264 -0
  193. data/lib/pdf_generator_api_client/models/form_configuration_new_actions_inner.rb +105 -0
  194. data/lib/pdf_generator_api_client/models/form_fields_base64.rb +271 -0
  195. data/lib/pdf_generator_api_client/models/form_fields_inner.rb +286 -0
  196. data/lib/pdf_generator_api_client/models/form_fields_url.rb +271 -0
  197. data/lib/pdf_generator_api_client/models/form_fill_base64.rb +321 -0
  198. data/lib/pdf_generator_api_client/models/form_fill_url.rb +321 -0
  199. data/lib/pdf_generator_api_client/models/format_param.rb +40 -0
  200. data/lib/pdf_generator_api_client/models/generate_document_asynchronous_request.rb +318 -0
  201. data/lib/pdf_generator_api_client/models/generate_document_batch_asynchronous_request.rb +308 -0
  202. data/lib/pdf_generator_api_client/models/generate_document_batch_request.rb +299 -0
  203. data/lib/pdf_generator_api_client/models/generate_document_request.rb +309 -0
  204. data/lib/pdf_generator_api_client/models/generate_qr_code201_response.rb +230 -0
  205. data/lib/pdf_generator_api_client/models/generate_qr_code201_response_meta.rb +231 -0
  206. data/lib/pdf_generator_api_client/models/generate_qr_code_request.rb +316 -0
  207. data/lib/pdf_generator_api_client/models/get_status200_response.rb +299 -0
  208. data/lib/pdf_generator_api_client/models/get_template_library200_response.rb +222 -0
  209. data/lib/pdf_generator_api_client/models/get_template_version422_response.rb +220 -0
  210. data/lib/pdf_generator_api_client/models/import_form_base64.rb +247 -0
  211. data/lib/pdf_generator_api_client/models/import_form_request.rb +105 -0
  212. data/lib/pdf_generator_api_client/models/import_form_url.rb +247 -0
  213. data/lib/pdf_generator_api_client/models/import_template_base64.rb +264 -0
  214. data/lib/pdf_generator_api_client/models/import_template_request.rb +105 -0
  215. data/lib/pdf_generator_api_client/models/import_template_url.rb +264 -0
  216. data/lib/pdf_generator_api_client/models/import_template_url_template.rb +238 -0
  217. data/lib/pdf_generator_api_client/models/inline_object.rb +230 -0
  218. data/lib/pdf_generator_api_client/models/inline_object1.rb +220 -0
  219. data/lib/pdf_generator_api_client/models/inline_object10.rb +232 -0
  220. data/lib/pdf_generator_api_client/models/inline_object10_meta.rb +251 -0
  221. data/lib/pdf_generator_api_client/models/inline_object11.rb +230 -0
  222. data/lib/pdf_generator_api_client/models/inline_object11_meta.rb +261 -0
  223. data/lib/pdf_generator_api_client/models/inline_object12.rb +230 -0
  224. data/lib/pdf_generator_api_client/models/inline_object12_meta.rb +270 -0
  225. data/lib/pdf_generator_api_client/models/inline_object12_meta_stats.rb +231 -0
  226. data/lib/pdf_generator_api_client/models/inline_object13.rb +265 -0
  227. data/lib/pdf_generator_api_client/models/inline_object14.rb +223 -0
  228. data/lib/pdf_generator_api_client/models/inline_object14_response_value.rb +401 -0
  229. data/lib/pdf_generator_api_client/models/inline_object14_response_value_default.rb +107 -0
  230. data/lib/pdf_generator_api_client/models/inline_object14_response_value_value.rb +107 -0
  231. data/lib/pdf_generator_api_client/models/inline_object15.rb +231 -0
  232. data/lib/pdf_generator_api_client/models/inline_object16.rb +229 -0
  233. data/lib/pdf_generator_api_client/models/inline_object17.rb +220 -0
  234. data/lib/pdf_generator_api_client/models/inline_object18.rb +230 -0
  235. data/lib/pdf_generator_api_client/models/inline_object18_meta.rb +221 -0
  236. data/lib/pdf_generator_api_client/models/inline_object19.rb +221 -0
  237. data/lib/pdf_generator_api_client/models/inline_object1_response.rb +223 -0
  238. data/lib/pdf_generator_api_client/models/inline_object2.rb +220 -0
  239. data/lib/pdf_generator_api_client/models/inline_object20.rb +220 -0
  240. data/lib/pdf_generator_api_client/models/inline_object20_response.rb +221 -0
  241. data/lib/pdf_generator_api_client/models/inline_object21.rb +255 -0
  242. data/lib/pdf_generator_api_client/models/inline_object22.rb +255 -0
  243. data/lib/pdf_generator_api_client/models/inline_object23.rb +255 -0
  244. data/lib/pdf_generator_api_client/models/inline_object24.rb +255 -0
  245. data/lib/pdf_generator_api_client/models/inline_object25.rb +231 -0
  246. data/lib/pdf_generator_api_client/models/inline_object26.rb +221 -0
  247. data/lib/pdf_generator_api_client/models/inline_object27.rb +221 -0
  248. data/lib/pdf_generator_api_client/models/inline_object3.rb +220 -0
  249. data/lib/pdf_generator_api_client/models/inline_object4.rb +231 -0
  250. data/lib/pdf_generator_api_client/models/inline_object5.rb +231 -0
  251. data/lib/pdf_generator_api_client/models/inline_object6.rb +231 -0
  252. data/lib/pdf_generator_api_client/models/inline_object7.rb +220 -0
  253. data/lib/pdf_generator_api_client/models/inline_object7_response.rb +220 -0
  254. data/lib/pdf_generator_api_client/models/inline_object8.rb +220 -0
  255. data/lib/pdf_generator_api_client/models/inline_object9.rb +230 -0
  256. data/lib/pdf_generator_api_client/models/inline_object9_meta.rb +261 -0
  257. data/lib/pdf_generator_api_client/models/inline_object_meta.rb +231 -0
  258. data/lib/pdf_generator_api_client/models/key_field_param.rb +40 -0
  259. data/lib/pdf_generator_api_client/models/make_accessible_base64.rb +315 -0
  260. data/lib/pdf_generator_api_client/models/make_accessible_request.rb +105 -0
  261. data/lib/pdf_generator_api_client/models/make_accessible_url.rb +315 -0
  262. data/lib/pdf_generator_api_client/models/metadata_param.rb +236 -0
  263. data/lib/pdf_generator_api_client/models/open_editor_request.rb +264 -0
  264. data/lib/pdf_generator_api_client/models/open_editor_request_data.rb +106 -0
  265. data/lib/pdf_generator_api_client/models/optimize_base64.rb +294 -0
  266. data/lib/pdf_generator_api_client/models/optimize_document_request.rb +105 -0
  267. data/lib/pdf_generator_api_client/models/optimize_url.rb +294 -0
  268. data/lib/pdf_generator_api_client/models/output_param.rb +42 -0
  269. data/lib/pdf_generator_api_client/models/pagination_meta.rb +239 -0
  270. data/lib/pdf_generator_api_client/models/promote_template_version200_response.rb +220 -0
  271. data/lib/pdf_generator_api_client/models/public_template_library_item.rb +265 -0
  272. data/lib/pdf_generator_api_client/models/status_param.rb +40 -0
  273. data/lib/pdf_generator_api_client/models/store_document_request.rb +289 -0
  274. data/lib/pdf_generator_api_client/models/template.rb +274 -0
  275. data/lib/pdf_generator_api_client/models/template_definition.rb +292 -0
  276. data/lib/pdf_generator_api_client/models/template_definition_data_settings.rb +234 -0
  277. data/lib/pdf_generator_api_client/models/template_definition_editor.rb +221 -0
  278. data/lib/pdf_generator_api_client/models/template_definition_new.rb +324 -0
  279. data/lib/pdf_generator_api_client/models/template_definition_new_data_settings.rb +245 -0
  280. data/lib/pdf_generator_api_client/models/template_definition_new_editor.rb +221 -0
  281. data/lib/pdf_generator_api_client/models/template_definition_new_layout.rb +377 -0
  282. data/lib/pdf_generator_api_client/models/template_definition_new_layout_margins.rb +248 -0
  283. data/lib/pdf_generator_api_client/models/template_definition_new_layout_repeat_layout.rb +276 -0
  284. data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner.rb +295 -0
  285. data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner_margins.rb +231 -0
  286. data/lib/pdf_generator_api_client/models/template_definition_pages_inner.rb +251 -0
  287. data/lib/pdf_generator_api_client/models/template_param.rb +240 -0
  288. data/lib/pdf_generator_api_client/models/template_param_data.rb +105 -0
  289. data/lib/pdf_generator_api_client/models/template_param_id.rb +106 -0
  290. data/lib/pdf_generator_api_client/models/template_version.rb +301 -0
  291. data/lib/pdf_generator_api_client/models/template_version_collection.rb +231 -0
  292. data/lib/pdf_generator_api_client/models/template_version_collection_meta.rb +238 -0
  293. data/lib/pdf_generator_api_client/models/watermark_base64.rb +320 -0
  294. data/lib/pdf_generator_api_client/models/watermark_file_url_watermark.rb +229 -0
  295. data/lib/pdf_generator_api_client/models/watermark_image.rb +104 -0
  296. data/lib/pdf_generator_api_client/models/watermark_image_content_base64.rb +351 -0
  297. data/lib/pdf_generator_api_client/models/watermark_image_content_url.rb +351 -0
  298. data/lib/pdf_generator_api_client/models/watermark_position.rb +47 -0
  299. data/lib/pdf_generator_api_client/models/watermark_text.rb +403 -0
  300. data/lib/pdf_generator_api_client/models/workspace.rb +250 -0
  301. data/lib/pdf_generator_api_client/version.rb +15 -0
  302. data/lib/pdf_generator_api_client.rb +185 -0
  303. data/pdf_generator_api_client.gemspec +39 -0
  304. data/spec/api/assets_api_spec.rb +47 -0
  305. data/spec/api/conversion_api_spec.rb +71 -0
  306. data/spec/api/documents_api_spec.rb +147 -0
  307. data/spec/api/e_invoices_api_spec.rb +82 -0
  308. data/spec/api/forms_api_spec.rb +144 -0
  309. data/spec/api/misc_api_spec.rb +46 -0
  310. data/spec/api/services_api_spec.rb +119 -0
  311. data/spec/api/template_library_api_spec.rb +59 -0
  312. data/spec/api/template_versions_api_spec.rb +88 -0
  313. data/spec/api/templates_api_spec.rb +173 -0
  314. data/spec/api/workspaces_api_spec.rb +84 -0
  315. data/spec/models/accessibility_option_spec.rb +30 -0
  316. data/spec/models/add_watermark_request_spec.rb +32 -0
  317. data/spec/models/async_output_param_spec.rb +30 -0
  318. data/spec/models/callback_param_spec.rb +42 -0
  319. data/spec/models/component_spec.rb +88 -0
  320. data/spec/models/convert_html2_pdf_request_spec.rb +72 -0
  321. data/spec/models/convert_pdf2_image_request_spec.rb +86 -0
  322. data/spec/models/convert_url2_pdf_request_spec.rb +72 -0
  323. data/spec/models/copy_template_request_spec.rb +36 -0
  324. data/spec/models/create_e_invoice_request_spec.rb +56 -0
  325. data/spec/models/create_factur_xe_invoice_request_spec.rb +64 -0
  326. data/spec/models/create_factur_xe_invoice_request_template_spec.rb +48 -0
  327. data/spec/models/create_workspace_request_spec.rb +36 -0
  328. data/spec/models/data_batch_inner_spec.rb +42 -0
  329. data/spec/models/document_spec.rb +60 -0
  330. data/spec/models/encrypt_and_decrypt_base64_spec.rb +64 -0
  331. data/spec/models/encrypt_and_decrypt_url_spec.rb +64 -0
  332. data/spec/models/encrypt_document_request_spec.rb +32 -0
  333. data/spec/models/extract_form_fields_request_spec.rb +32 -0
  334. data/spec/models/fill_form_fields_request_spec.rb +32 -0
  335. data/spec/models/form_action_download_spec.rb +36 -0
  336. data/spec/models/form_action_send_send_document_headers_inner_spec.rb +42 -0
  337. data/spec/models/form_action_send_send_document_spec.rb +42 -0
  338. data/spec/models/form_action_send_spec.rb +36 -0
  339. data/spec/models/form_action_store_spec.rb +36 -0
  340. data/spec/models/form_configuration_new_actions_inner_spec.rb +21 -0
  341. data/spec/models/form_configuration_new_spec.rb +60 -0
  342. data/spec/models/form_configuration_spec.rb +48 -0
  343. data/spec/models/form_fields_base64_spec.rb +42 -0
  344. data/spec/models/form_fields_inner_spec.rb +58 -0
  345. data/spec/models/form_fields_url_spec.rb +42 -0
  346. data/spec/models/form_fill_base64_spec.rb +58 -0
  347. data/spec/models/form_fill_url_spec.rb +58 -0
  348. data/spec/models/format_param_spec.rb +30 -0
  349. data/spec/models/generate_document_asynchronous_request_spec.rb +78 -0
  350. data/spec/models/generate_document_batch_asynchronous_request_spec.rb +72 -0
  351. data/spec/models/generate_document_batch_request_spec.rb +66 -0
  352. data/spec/models/generate_document_request_spec.rb +72 -0
  353. data/spec/models/generate_qr_code201_response_meta_spec.rb +42 -0
  354. data/spec/models/generate_qr_code201_response_spec.rb +42 -0
  355. data/spec/models/generate_qr_code_request_spec.rb +64 -0
  356. data/spec/models/get_status200_response_spec.rb +66 -0
  357. data/spec/models/get_template_library200_response_spec.rb +36 -0
  358. data/spec/models/get_template_version422_response_spec.rb +36 -0
  359. data/spec/models/import_form_base64_spec.rb +42 -0
  360. data/spec/models/import_form_request_spec.rb +32 -0
  361. data/spec/models/import_form_url_spec.rb +42 -0
  362. data/spec/models/import_template_base64_spec.rb +42 -0
  363. data/spec/models/import_template_request_spec.rb +32 -0
  364. data/spec/models/import_template_url_spec.rb +42 -0
  365. data/spec/models/import_template_url_template_spec.rb +36 -0
  366. data/spec/models/inline_object10_meta_spec.rb +54 -0
  367. data/spec/models/inline_object10_spec.rb +42 -0
  368. data/spec/models/inline_object11_meta_spec.rb +60 -0
  369. data/spec/models/inline_object11_spec.rb +42 -0
  370. data/spec/models/inline_object12_meta_spec.rb +66 -0
  371. data/spec/models/inline_object12_meta_stats_spec.rb +42 -0
  372. data/spec/models/inline_object12_spec.rb +42 -0
  373. data/spec/models/inline_object13_spec.rb +46 -0
  374. data/spec/models/inline_object14_response_value_default_spec.rb +32 -0
  375. data/spec/models/inline_object14_response_value_spec.rb +124 -0
  376. data/spec/models/inline_object14_response_value_value_spec.rb +32 -0
  377. data/spec/models/inline_object14_spec.rb +36 -0
  378. data/spec/models/inline_object15_spec.rb +42 -0
  379. data/spec/models/inline_object16_spec.rb +42 -0
  380. data/spec/models/inline_object17_spec.rb +36 -0
  381. data/spec/models/inline_object18_meta_spec.rb +36 -0
  382. data/spec/models/inline_object18_spec.rb +42 -0
  383. data/spec/models/inline_object19_spec.rb +36 -0
  384. data/spec/models/inline_object1_response_spec.rb +36 -0
  385. data/spec/models/inline_object1_spec.rb +36 -0
  386. data/spec/models/inline_object20_response_spec.rb +36 -0
  387. data/spec/models/inline_object20_spec.rb +36 -0
  388. data/spec/models/inline_object21_spec.rb +40 -0
  389. data/spec/models/inline_object22_spec.rb +40 -0
  390. data/spec/models/inline_object23_spec.rb +40 -0
  391. data/spec/models/inline_object24_spec.rb +40 -0
  392. data/spec/models/inline_object25_spec.rb +42 -0
  393. data/spec/models/inline_object26_spec.rb +36 -0
  394. data/spec/models/inline_object27_spec.rb +36 -0
  395. data/spec/models/inline_object2_spec.rb +36 -0
  396. data/spec/models/inline_object3_spec.rb +36 -0
  397. data/spec/models/inline_object4_spec.rb +42 -0
  398. data/spec/models/inline_object5_spec.rb +42 -0
  399. data/spec/models/inline_object6_spec.rb +42 -0
  400. data/spec/models/inline_object7_response_spec.rb +36 -0
  401. data/spec/models/inline_object7_spec.rb +36 -0
  402. data/spec/models/inline_object8_spec.rb +36 -0
  403. data/spec/models/inline_object9_meta_spec.rb +60 -0
  404. data/spec/models/inline_object9_spec.rb +42 -0
  405. data/spec/models/inline_object_meta_spec.rb +42 -0
  406. data/spec/models/inline_object_spec.rb +42 -0
  407. data/spec/models/key_field_param_spec.rb +30 -0
  408. data/spec/models/make_accessible_base64_spec.rb +64 -0
  409. data/spec/models/make_accessible_request_spec.rb +32 -0
  410. data/spec/models/make_accessible_url_spec.rb +64 -0
  411. data/spec/models/metadata_param_spec.rb +42 -0
  412. data/spec/models/open_editor_request_data_spec.rb +32 -0
  413. data/spec/models/open_editor_request_spec.rb +46 -0
  414. data/spec/models/optimize_base64_spec.rb +52 -0
  415. data/spec/models/optimize_document_request_spec.rb +32 -0
  416. data/spec/models/optimize_url_spec.rb +52 -0
  417. data/spec/models/output_param_spec.rb +30 -0
  418. data/spec/models/pagination_meta_spec.rb +48 -0
  419. data/spec/models/promote_template_version200_response_spec.rb +36 -0
  420. data/spec/models/public_template_library_item_spec.rb +60 -0
  421. data/spec/models/status_param_spec.rb +30 -0
  422. data/spec/models/store_document_request_spec.rb +58 -0
  423. data/spec/models/template_definition_data_settings_spec.rb +42 -0
  424. data/spec/models/template_definition_editor_spec.rb +36 -0
  425. data/spec/models/template_definition_new_data_settings_spec.rb +48 -0
  426. data/spec/models/template_definition_new_editor_spec.rb +36 -0
  427. data/spec/models/template_definition_new_layout_margins_spec.rb +54 -0
  428. data/spec/models/template_definition_new_layout_repeat_layout_spec.rb +52 -0
  429. data/spec/models/template_definition_new_layout_spec.rb +100 -0
  430. data/spec/models/template_definition_new_pages_inner_margins_spec.rb +42 -0
  431. data/spec/models/template_definition_new_pages_inner_spec.rb +78 -0
  432. data/spec/models/template_definition_new_spec.rb +84 -0
  433. data/spec/models/template_definition_pages_inner_spec.rb +54 -0
  434. data/spec/models/template_definition_spec.rb +78 -0
  435. data/spec/models/template_param_data_spec.rb +32 -0
  436. data/spec/models/template_param_id_spec.rb +32 -0
  437. data/spec/models/template_param_spec.rb +48 -0
  438. data/spec/models/template_spec.rb +66 -0
  439. data/spec/models/template_version_collection_meta_spec.rb +48 -0
  440. data/spec/models/template_version_collection_spec.rb +42 -0
  441. data/spec/models/template_version_spec.rb +90 -0
  442. data/spec/models/watermark_base64_spec.rb +58 -0
  443. data/spec/models/watermark_file_url_watermark_spec.rb +42 -0
  444. data/spec/models/watermark_image_content_base64_spec.rb +54 -0
  445. data/spec/models/watermark_image_content_url_spec.rb +54 -0
  446. data/spec/models/watermark_image_spec.rb +21 -0
  447. data/spec/models/watermark_position_spec.rb +30 -0
  448. data/spec/models/watermark_text_spec.rb +66 -0
  449. data/spec/models/workspace_spec.rb +54 -0
  450. data/spec/spec_helper.rb +111 -0
  451. metadata +679 -0
@@ -0,0 +1,24 @@
1
+ # PDFGeneratorAPI::WatermarkBase64
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **file_base64** | **String** | PDF file from base64 string to add the watermark to | |
8
+ | **watermark** | [**WatermarkFileUrlWatermark**](WatermarkFileUrlWatermark.md) | | |
9
+ | **output** | **String** | Returned document output | [optional][default to 'base64'] |
10
+ | **name** | **String** | File name of the returned document | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pdf_generator_api_client'
16
+
17
+ instance = PDFGeneratorAPI::WatermarkBase64.new(
18
+ file_base64: null,
19
+ watermark: null,
20
+ output: null,
21
+ name: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # PDFGeneratorAPI::WatermarkFileUrlWatermark
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **image** | [**WatermarkImage**](WatermarkImage.md) | | [optional] |
8
+ | **text** | [**WatermarkText**](WatermarkText.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'pdf_generator_api_client'
14
+
15
+ instance = PDFGeneratorAPI::WatermarkFileUrlWatermark.new(
16
+ image: null,
17
+ text: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # PDFGeneratorAPI::WatermarkImage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content_url** | **String** | URL to an image | |
8
+ | **position** | [**WatermarkPosition**](WatermarkPosition.md) | | [optional][default to 'center'] |
9
+ | **rotation** | **Integer** | Watermark rotation | [optional][default to 0] |
10
+ | **scale** | **Float** | Watermark image scale | [optional][default to 1] |
11
+ | **content_base64** | **String** | Base64 image string | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'pdf_generator_api_client'
17
+
18
+ instance = PDFGeneratorAPI::WatermarkImage.new(
19
+ content_url: null,
20
+ position: null,
21
+ rotation: null,
22
+ scale: null,
23
+ content_base64: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # PDFGeneratorAPI::WatermarkImageContentBase64
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content_base64** | **String** | Base64 image string | |
8
+ | **position** | [**WatermarkPosition**](WatermarkPosition.md) | | [optional][default to 'center'] |
9
+ | **rotation** | **Integer** | Watermark rotation | [optional][default to 0] |
10
+ | **scale** | **Float** | Watermark image scale | [optional][default to 1] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pdf_generator_api_client'
16
+
17
+ instance = PDFGeneratorAPI::WatermarkImageContentBase64.new(
18
+ content_base64: null,
19
+ position: null,
20
+ rotation: null,
21
+ scale: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # PDFGeneratorAPI::WatermarkImageContentUrl
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content_url** | **String** | URL to an image | |
8
+ | **position** | [**WatermarkPosition**](WatermarkPosition.md) | | [optional][default to 'center'] |
9
+ | **rotation** | **Integer** | Watermark rotation | [optional][default to 0] |
10
+ | **scale** | **Float** | Watermark image scale | [optional][default to 1] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pdf_generator_api_client'
16
+
17
+ instance = PDFGeneratorAPI::WatermarkImageContentUrl.new(
18
+ content_url: null,
19
+ position: null,
20
+ rotation: null,
21
+ scale: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,15 @@
1
+ # PDFGeneratorAPI::WatermarkPosition
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'pdf_generator_api_client'
12
+
13
+ instance = PDFGeneratorAPI::WatermarkPosition.new()
14
+ ```
15
+
@@ -0,0 +1,28 @@
1
+ # PDFGeneratorAPI::WatermarkText
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **content** | **String** | Watermark text | |
8
+ | **color** | **String** | Watermark text color in hexadecimal format | [optional][default to '#000000'] |
9
+ | **size** | **Integer** | Watermark text font size in px | [optional][default to 48] |
10
+ | **opacity** | **Float** | Watermark text opaxity | [optional][default to 0.5] |
11
+ | **position** | [**WatermarkPosition**](WatermarkPosition.md) | | [optional][default to 'center'] |
12
+ | **rotation** | **Integer** | Watermark rotation | [optional][default to 0] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'pdf_generator_api_client'
18
+
19
+ instance = PDFGeneratorAPI::WatermarkText.new(
20
+ content: null,
21
+ color: null,
22
+ size: null,
23
+ opacity: null,
24
+ position: null,
25
+ rotation: null
26
+ )
27
+ ```
28
+
data/docs/Workspace.md ADDED
@@ -0,0 +1,24 @@
1
+ # PDFGeneratorAPI::Workspace
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | Internal workspace id | [optional] |
8
+ | **identifier** | **String** | The unique workspace idenfitifer specified by your application | [optional] |
9
+ | **is_master_workspace** | **Boolean** | True if a master workspace | [optional] |
10
+ | **created_at** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pdf_generator_api_client'
16
+
17
+ instance = PDFGeneratorAPI::Workspace.new(
18
+ id: 1,
19
+ identifier: demo.example@actualreports.com,
20
+ is_master_workspace: false,
21
+ created_at: 2020-04-01 12:03:12
22
+ )
23
+ ```
24
+
@@ -0,0 +1,292 @@
1
+ # PDFGeneratorAPI::WorkspacesApi
2
+
3
+ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_workspace**](WorkspacesApi.md#create_workspace) | **POST** /workspaces | Create workspace |
8
+ | [**delete_workspace**](WorkspacesApi.md#delete_workspace) | **DELETE** /workspaces/{workspaceIdentifier} | Delete workspace |
9
+ | [**get_workspace**](WorkspacesApi.md#get_workspace) | **GET** /workspaces/{workspaceIdentifier} | Get workspace |
10
+ | [**get_workspaces**](WorkspacesApi.md#get_workspaces) | **GET** /workspaces | Get workspaces |
11
+
12
+
13
+ ## create_workspace
14
+
15
+ > <InlineObject8> create_workspace(opts)
16
+
17
+ Create workspace
18
+
19
+ Creates a regular workspace with identifier specified in the request.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'pdf_generator_api_client'
26
+ # setup authorization
27
+ PDFGeneratorAPI.configure do |config|
28
+ # Configure Bearer authorization (JWT): JSONWebTokenAuth
29
+ config.access_token = 'YOUR_BEARER_TOKEN'
30
+ end
31
+
32
+ api_instance = PDFGeneratorAPI::WorkspacesApi.new
33
+ opts = {
34
+ create_workspace_request: PDFGeneratorAPI::CreateWorkspaceRequest.new # CreateWorkspaceRequest |
35
+ }
36
+
37
+ begin
38
+ # Create workspace
39
+ result = api_instance.create_workspace(opts)
40
+ p result
41
+ rescue PDFGeneratorAPI::ApiError => e
42
+ puts "Error when calling WorkspacesApi->create_workspace: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the create_workspace_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<InlineObject8>, Integer, Hash)> create_workspace_with_http_info(opts)
51
+
52
+ ```ruby
53
+ begin
54
+ # Create workspace
55
+ data, status_code, headers = api_instance.create_workspace_with_http_info(opts)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <InlineObject8>
59
+ rescue PDFGeneratorAPI::ApiError => e
60
+ puts "Error when calling WorkspacesApi->create_workspace_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **create_workspace_request** | [**CreateWorkspaceRequest**](CreateWorkspaceRequest.md) | | [optional] |
69
+
70
+ ### Return type
71
+
72
+ [**InlineObject8**](InlineObject8.md)
73
+
74
+ ### Authorization
75
+
76
+ [JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## delete_workspace
85
+
86
+ > delete_workspace(workspace_identifier)
87
+
88
+ Delete workspace
89
+
90
+ Delete workspace. Only regular workspaces can be deleted.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'pdf_generator_api_client'
97
+ # setup authorization
98
+ PDFGeneratorAPI.configure do |config|
99
+ # Configure Bearer authorization (JWT): JSONWebTokenAuth
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+ end
102
+
103
+ api_instance = PDFGeneratorAPI::WorkspacesApi.new
104
+ workspace_identifier = 'demo.example@actualreports.com' # String | Workspace identifier
105
+
106
+ begin
107
+ # Delete workspace
108
+ api_instance.delete_workspace(workspace_identifier)
109
+ rescue PDFGeneratorAPI::ApiError => e
110
+ puts "Error when calling WorkspacesApi->delete_workspace: #{e}"
111
+ end
112
+ ```
113
+
114
+ #### Using the delete_workspace_with_http_info variant
115
+
116
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
117
+
118
+ > <Array(nil, Integer, Hash)> delete_workspace_with_http_info(workspace_identifier)
119
+
120
+ ```ruby
121
+ begin
122
+ # Delete workspace
123
+ data, status_code, headers = api_instance.delete_workspace_with_http_info(workspace_identifier)
124
+ p status_code # => 2xx
125
+ p headers # => { ... }
126
+ p data # => nil
127
+ rescue PDFGeneratorAPI::ApiError => e
128
+ puts "Error when calling WorkspacesApi->delete_workspace_with_http_info: #{e}"
129
+ end
130
+ ```
131
+
132
+ ### Parameters
133
+
134
+ | Name | Type | Description | Notes |
135
+ | ---- | ---- | ----------- | ----- |
136
+ | **workspace_identifier** | **String** | Workspace identifier | |
137
+
138
+ ### Return type
139
+
140
+ nil (empty response body)
141
+
142
+ ### Authorization
143
+
144
+ [JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
145
+
146
+ ### HTTP request headers
147
+
148
+ - **Content-Type**: Not defined
149
+ - **Accept**: application/json
150
+
151
+
152
+ ## get_workspace
153
+
154
+ > <InlineObject8> get_workspace(workspace_identifier)
155
+
156
+ Get workspace
157
+
158
+ Returns workspace information for the workspace identifier specified in the request.
159
+
160
+ ### Examples
161
+
162
+ ```ruby
163
+ require 'time'
164
+ require 'pdf_generator_api_client'
165
+ # setup authorization
166
+ PDFGeneratorAPI.configure do |config|
167
+ # Configure Bearer authorization (JWT): JSONWebTokenAuth
168
+ config.access_token = 'YOUR_BEARER_TOKEN'
169
+ end
170
+
171
+ api_instance = PDFGeneratorAPI::WorkspacesApi.new
172
+ workspace_identifier = 'demo.example@actualreports.com' # String | Workspace identifier
173
+
174
+ begin
175
+ # Get workspace
176
+ result = api_instance.get_workspace(workspace_identifier)
177
+ p result
178
+ rescue PDFGeneratorAPI::ApiError => e
179
+ puts "Error when calling WorkspacesApi->get_workspace: #{e}"
180
+ end
181
+ ```
182
+
183
+ #### Using the get_workspace_with_http_info variant
184
+
185
+ This returns an Array which contains the response data, status code and headers.
186
+
187
+ > <Array(<InlineObject8>, Integer, Hash)> get_workspace_with_http_info(workspace_identifier)
188
+
189
+ ```ruby
190
+ begin
191
+ # Get workspace
192
+ data, status_code, headers = api_instance.get_workspace_with_http_info(workspace_identifier)
193
+ p status_code # => 2xx
194
+ p headers # => { ... }
195
+ p data # => <InlineObject8>
196
+ rescue PDFGeneratorAPI::ApiError => e
197
+ puts "Error when calling WorkspacesApi->get_workspace_with_http_info: #{e}"
198
+ end
199
+ ```
200
+
201
+ ### Parameters
202
+
203
+ | Name | Type | Description | Notes |
204
+ | ---- | ---- | ----------- | ----- |
205
+ | **workspace_identifier** | **String** | Workspace identifier | |
206
+
207
+ ### Return type
208
+
209
+ [**InlineObject8**](InlineObject8.md)
210
+
211
+ ### Authorization
212
+
213
+ [JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
214
+
215
+ ### HTTP request headers
216
+
217
+ - **Content-Type**: Not defined
218
+ - **Accept**: application/json
219
+
220
+
221
+ ## get_workspaces
222
+
223
+ > <InlineObject5> get_workspaces(opts)
224
+
225
+ Get workspaces
226
+
227
+ Returns all workspaces in the organization
228
+
229
+ ### Examples
230
+
231
+ ```ruby
232
+ require 'time'
233
+ require 'pdf_generator_api_client'
234
+ # setup authorization
235
+ PDFGeneratorAPI.configure do |config|
236
+ # Configure Bearer authorization (JWT): JSONWebTokenAuth
237
+ config.access_token = 'YOUR_BEARER_TOKEN'
238
+ end
239
+
240
+ api_instance = PDFGeneratorAPI::WorkspacesApi.new
241
+ opts = {
242
+ page: 1, # Integer | Pagination: page to return
243
+ per_page: 20 # Integer | Pagination: How many records to return per page
244
+ }
245
+
246
+ begin
247
+ # Get workspaces
248
+ result = api_instance.get_workspaces(opts)
249
+ p result
250
+ rescue PDFGeneratorAPI::ApiError => e
251
+ puts "Error when calling WorkspacesApi->get_workspaces: #{e}"
252
+ end
253
+ ```
254
+
255
+ #### Using the get_workspaces_with_http_info variant
256
+
257
+ This returns an Array which contains the response data, status code and headers.
258
+
259
+ > <Array(<InlineObject5>, Integer, Hash)> get_workspaces_with_http_info(opts)
260
+
261
+ ```ruby
262
+ begin
263
+ # Get workspaces
264
+ data, status_code, headers = api_instance.get_workspaces_with_http_info(opts)
265
+ p status_code # => 2xx
266
+ p headers # => { ... }
267
+ p data # => <InlineObject5>
268
+ rescue PDFGeneratorAPI::ApiError => e
269
+ puts "Error when calling WorkspacesApi->get_workspaces_with_http_info: #{e}"
270
+ end
271
+ ```
272
+
273
+ ### Parameters
274
+
275
+ | Name | Type | Description | Notes |
276
+ | ---- | ---- | ----------- | ----- |
277
+ | **page** | **Integer** | Pagination: page to return | [optional][default to 1] |
278
+ | **per_page** | **Integer** | Pagination: How many records to return per page | [optional][default to 15] |
279
+
280
+ ### Return type
281
+
282
+ [**InlineObject5**](InlineObject5.md)
283
+
284
+ ### Authorization
285
+
286
+ [JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
287
+
288
+ ### HTTP request headers
289
+
290
+ - **Content-Type**: Not defined
291
+ - **Accept**: application/json
292
+
data/git_push.sh ADDED
@@ -0,0 +1,57 @@
1
+ #!/bin/sh
2
+ # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
3
+ #
4
+ # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
5
+
6
+ git_user_id=$1
7
+ git_repo_id=$2
8
+ release_note=$3
9
+ git_host=$4
10
+
11
+ if [ "$git_host" = "" ]; then
12
+ git_host="github.com"
13
+ echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14
+ fi
15
+
16
+ if [ "$git_user_id" = "" ]; then
17
+ git_user_id="pdfgeneratorapi"
18
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
19
+ fi
20
+
21
+ if [ "$git_repo_id" = "" ]; then
22
+ git_repo_id="ruby-client"
23
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
24
+ fi
25
+
26
+ if [ "$release_note" = "" ]; then
27
+ release_note="Minor update"
28
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
29
+ fi
30
+
31
+ # Initialize the local directory as a Git repository
32
+ git init
33
+
34
+ # Adds the files in the local repository and stages them for commit.
35
+ git add .
36
+
37
+ # Commits the tracked changes and prepares them to be pushed to a remote repository.
38
+ git commit -m "$release_note"
39
+
40
+ # Sets the new remote
41
+ git_remote=$(git remote)
42
+ if [ "$git_remote" = "" ]; then # git remote not defined
43
+
44
+ if [ "$GIT_TOKEN" = "" ]; then
45
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
46
+ git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
47
+ else
48
+ git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
49
+ fi
50
+
51
+ fi
52
+
53
+ git pull origin master
54
+
55
+ # Pushes (Forces) the changes in the local repository up to the remote repository
56
+ echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
57
+ git push origin master 2>&1 | grep -v 'To https'
@@ -0,0 +1,90 @@
1
+ =begin
2
+ #PDF Generator API
3
+
4
+ ## Introduction [PDF Generator API](https://pdfgeneratorapi.com) allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor. The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding. ## Base URL The base URL for all the API endpoints is `https://us1.pdfgeneratorapi.com/api/v4` For example * `https://us1.pdfgeneratorapi.com/api/v4/templates` * `https://us1.pdfgeneratorapi.com/api/v4/workspaces` * `https://us1.pdfgeneratorapi.com/api/v4/templates/123123` ## Editor PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our [Support Portal](https://support.pdfgeneratorapi.com). * [Component specification](https://support.pdfgeneratorapi.com/en/category/components-1ffseaj/) * [Expression Language documentation](https://support.pdfgeneratorapi.com/en/category/expression-language-q203pa/) * [Frequently asked questions and answers](https://support.pdfgeneratorapi.com/en/category/qanda-1ov519d/) ## Definitions ### Organization Organization is a group of workspaces owned by your account. ### Workspace Workspace contains templates. Each workspace has access to their own templates and organization default templates. ### Master Workspace Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with. ### Default Template Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has \"Organization\" access then your users can use them from the \"New\" menu in the Editor. ### Data Field Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field `{paymentDetails::buyerName}`. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template. ``` { \"documentNumber\": 1, \"paymentDetails\": { \"method\": \"Credit Card\", \"buyerName\": \"John Smith\" }, \"items\": [ { \"id\": 1, \"name\": \"Item one\" } ] } ``` ## Rate limiting Our API endpoints use IP-based rate limiting and allow you to make up to 2 requests per second and 60 requests per minute. If you make more requests, you will receive a response with HTTP code 429. Response headers contain additional values: | Header | Description | |--------|--------------------------------| | X-RateLimit-Limit | Maximum requests per minute | | X-RateLimit-Remaining | The requests remaining in the current minute | | Retry-After | How many seconds you need to wait until you are allowed to make requests | * * * * * # Libraries and SDKs ## Postman Collection We have created a [Postman Collection](https://www.postman.com/pdfgeneratorapi/workspace/pdf-generator-api-public-workspace/overview) so you can easily test all the API endpoints without developing and code. ## Client Libraries All our Client Libraries are auto-generated using [OpenAPI Generator](https://openapi-generator.tech/) which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language. * [PHP Client](https://github.com/pdfgeneratorapi/php-client) * [Java Client](https://github.com/pdfgeneratorapi/java-client) * [Ruby Client](https://github.com/pdfgeneratorapi/ruby-client) * [Python Client](https://github.com/pdfgeneratorapi/python-client) * [Javascript Client](https://github.com/pdfgeneratorapi/javascript-client) We have validated the generated libraries, but let us know if you find any anomalies in the client code. ## Model Context Protocol (MCP) Server Integrate document generation directly into your AI agents and LLM applications using our official Model Context Protocol (MCP) Server. The MCP server provides a standardized interface that allows AI assistants (like Claude Desktop and other MCP-compatible clients) to securely interact with the PDF Generator API. With it, your AI applications can automatically fetch workspaces, retrieve templates, merge data, and generate PDF documents on the fly. [Get PDF Generator API MCP Server](https://github.com/pdfgeneratorapi/mcp-server) * * * * * # Authentication The PDF Generator API uses __JSON Web Tokens (JWT)__ to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a __server-side application__ and included as a __Bearer Token__ in the header of each request. <SecurityDefinitions /> ## Accessing your API Key and Secret You can find your __API Key__ and __API Secret__ from the __Account Settings__ page after you login to PDF Generator API [here](https://pdfgeneratorapi.com/login). ## Creating a JWT JSON Web Tokens are composed of three sections: a header, a payload (containing a claim set), and a signature. The header and payload are JSON objects, which are serialized to UTF-8 bytes, then encoded using base64url encoding. The JWT's header, payload, and signature are concatenated with periods (.). As a result, a JWT typically takes the following form: ``` {Base64url encoded header}.{Base64url encoded payload}.{Base64url encoded signature} ``` We recommend and support libraries provided on [jwt.io](https://jwt.io/). While other libraries can create JWT, these recommended libraries are the most robust. ### Header Property `alg` defines which signing algorithm is being used. PDF Generator API users HS256. Property `typ` defines the type of token and it is always JWT. ``` { \"alg\": \"HS256\", \"typ\": \"JWT\" } ``` ### Payload The second part of the token is the payload, which contains the claims or the pieces of information being passed about the user and any metadata required. It is mandatory to specify the following claims: * issuer (`iss`): Your API key * subject (`sub`): Workspace identifier * expiration time (`exp`): Timestamp (unix epoch time) until the token is valid. It is highly recommended to set the exp timestamp for a short period, i.e. a matter of seconds. This way, if a token is intercepted or shared, the token will only be valid for a short period of time. ``` { \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\", \"sub\": \"demo.example@actualreports.com\", \"exp\": 1586112639 } ``` ### Payload for Partners Our partners can send their unique identifier (provided by us) in JWT's partner_id claim. If the `partner_id` value is specified in the JWT, the organization making the request is automatically connected to the partner account. * Partner ID (`partner_id`): Unique identifier provide by PDF Generator API team ``` { \"iss\": \"ad54aaff89ffdfeff178bb8a8f359b29fcb20edb56250b9f584aa2cb0162ed4a\", \"sub\": \"demo.example@actualreports.com\", \"partner_id\": \"my-partner-identifier\", \"exp\": 1586112639 } ``` ### Signature To create the signature part you have to take the encoded header, the encoded payload, a secret, the algorithm specified in the header, and sign that. The signature is used to verify the message wasn't changed along the way, and, in the case of tokens signed with a private key, it can also verify that the sender of the JWT is who it says it is. ``` HMACSHA256( base64UrlEncode(header) + \".\" + base64UrlEncode(payload), API_SECRET) ``` ### Putting all together The output is three Base64-URL strings separated by dots. The following shows a JWT that has the previous header and payload encoded, and it is signed with a secret. ``` eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0.SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q // Base64 encoded header: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 // Base64 encoded payload: eyJpc3MiOiJhZDU0YWFmZjg5ZmZkZmVmZjE3OGJiOGE4ZjM1OWIyOWZjYjIwZWRiNTYyNTBiOWY1ODRhYTJjYjAxNjJlZDRhIiwic3ViIjoiZGVtby5leGFtcGxlQGFjdHVhbHJlcG9ydHMuY29tIn0 // Signature: SxO-H7UYYYsclS8RGWO1qf0z1cB1m73wF9FLl9RCc1Q ``` ## Temporary JWTs You can create a temporary token in [Account Settings](https://pdfgeneratorapi.com/account/organization) page after you login to PDF Generator API. The generated token uses your email address as the subject (`sub`) value and is valid for __15 minutes__. You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API calls. These test tokens should never be used in production applications. * * * * * # Error codes | Code | Description | |--------|--------------------------------| | 401 | Unauthorized | | 402 | Payment Required | | 403 | Forbidden | | 404 | Not Found | | 422 | Unprocessable Entity | | 429 | Too Many Requests | | 500 | Internal Server Error | ## 401 Unauthorized | Description | |-------------------------------------------------------------------------| | Authentication failed: request expired | | Authentication failed: workspace missing | | Authentication failed: key missing | | Authentication failed: property 'iss' (issuer) missing in JWT | | Authentication failed: property 'sub' (subject) missing in JWT | | Authentication failed: property 'exp' (expiration time) missing in JWT | | Authentication failed: incorrect signature | ## 402 Payment Required | Description | |-------------------------------------------------------------------------| | Your account is suspended, please upgrade your account | ## 403 Forbidden | Description | |-------------------------------------------------------------------------| | Your account has exceeded the monthly document generation limit. | | Access not granted: You cannot delete master workspace via API | | Access not granted: Template is not accessible by this organization | | Your session has expired, please close and reopen the editor. | ## 404 Entity not found | Description | |-------------------------------------------------------------------------| | Entity not found | | Resource not found | | None of the templates is available for the workspace. | ## 422 Unprocessable Entity | Description | |-------------------------------------------------------------------------| | Unable to parse JSON, please check formatting | | Required parameter missing | | Required parameter missing: template definition not defined | | Required parameter missing: template not defined | ## 429 Too Many Requests | Description | |-------------------------------------------------------------------------| | You can make up to 2 requests per second and 60 requests per minute. | * * * * *
5
+
6
+ The version of the OpenAPI document: 4.0.25
7
+ Contact: support@pdfgeneratorapi.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.14.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module PDFGeneratorAPI
16
+ class AssetsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Generate QR Code
23
+ # Creates a QR code based on the configuration
24
+ # @param generate_qr_code_request [GenerateQRCodeRequest] QR Code configuration
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [GenerateQRCode201Response]
27
+ def generate_qr_code(generate_qr_code_request, opts = {})
28
+ data, _status_code, _headers = generate_qr_code_with_http_info(generate_qr_code_request, opts)
29
+ data
30
+ end
31
+
32
+ # Generate QR Code
33
+ # Creates a QR code based on the configuration
34
+ # @param generate_qr_code_request [GenerateQRCodeRequest] QR Code configuration
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(GenerateQRCode201Response, Integer, Hash)>] GenerateQRCode201Response data, response status code and response headers
37
+ def generate_qr_code_with_http_info(generate_qr_code_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: AssetsApi.generate_qr_code ...'
40
+ end
41
+ # verify the required parameter 'generate_qr_code_request' is set
42
+ if @api_client.config.client_side_validation && generate_qr_code_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'generate_qr_code_request' when calling AssetsApi.generate_qr_code"
44
+ end
45
+ # resource path
46
+ local_var_path = '/assets/qrcode'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(generate_qr_code_request)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'GenerateQRCode201Response'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['JSONWebTokenAuth']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"AssetsApi.generate_qr_code",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: AssetsApi#generate_qr_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+ end
90
+ end