aspose_words_cloud 26.2 → 26.4

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 (360) hide show
  1. checksums.yaml +4 -4
  2. data/lib/aspose_words_cloud/api/words_api.rb +324 -0
  3. data/lib/aspose_words_cloud/api_client.rb +59 -0
  4. data/lib/aspose_words_cloud/job_handler.rb +93 -0
  5. data/lib/aspose_words_cloud/models/job_info.rb +266 -0
  6. data/lib/aspose_words_cloud/models/office_math_object.rb +2 -2
  7. data/lib/aspose_words_cloud/models/requests/accept_all_revisions_online_request.rb +12 -0
  8. data/lib/aspose_words_cloud/models/requests/accept_all_revisions_request.rb +8 -0
  9. data/lib/aspose_words_cloud/models/requests/append_document_job_request.rb +235 -0
  10. data/lib/aspose_words_cloud/models/requests/append_document_online_job_request.rb +233 -0
  11. data/lib/aspose_words_cloud/models/requests/append_document_online_request.rb +12 -0
  12. data/lib/aspose_words_cloud/models/requests/append_document_request.rb +8 -0
  13. data/lib/aspose_words_cloud/models/requests/apply_style_to_document_element_online_request.rb +12 -0
  14. data/lib/aspose_words_cloud/models/requests/apply_style_to_document_element_request.rb +8 -0
  15. data/lib/aspose_words_cloud/models/requests/build_report_online_request.rb +8 -0
  16. data/lib/aspose_words_cloud/models/requests/build_report_request.rb +8 -0
  17. data/lib/aspose_words_cloud/models/requests/compare_document_online_request.rb +12 -0
  18. data/lib/aspose_words_cloud/models/requests/compare_document_request.rb +8 -0
  19. data/lib/aspose_words_cloud/models/requests/compress_document_online_request.rb +12 -0
  20. data/lib/aspose_words_cloud/models/requests/compress_document_request.rb +8 -0
  21. data/lib/aspose_words_cloud/models/requests/convert_document_job_request.rb +226 -0
  22. data/lib/aspose_words_cloud/models/requests/convert_document_request.rb +8 -0
  23. data/lib/aspose_words_cloud/models/requests/copy_file_request.rb +8 -0
  24. data/lib/aspose_words_cloud/models/requests/copy_folder_request.rb +8 -0
  25. data/lib/aspose_words_cloud/models/requests/copy_style_online_request.rb +12 -0
  26. data/lib/aspose_words_cloud/models/requests/copy_style_request.rb +8 -0
  27. data/lib/aspose_words_cloud/models/requests/copy_styles_from_template_request.rb +8 -0
  28. data/lib/aspose_words_cloud/models/requests/create_document_request.rb +8 -0
  29. data/lib/aspose_words_cloud/models/requests/create_folder_request.rb +8 -0
  30. data/lib/aspose_words_cloud/models/requests/create_or_update_document_property_online_request.rb +12 -0
  31. data/lib/aspose_words_cloud/models/requests/create_or_update_document_property_request.rb +8 -0
  32. data/lib/aspose_words_cloud/models/requests/delete_all_paragraph_tab_stops_online_request.rb +12 -0
  33. data/lib/aspose_words_cloud/models/requests/delete_all_paragraph_tab_stops_request.rb +8 -0
  34. data/lib/aspose_words_cloud/models/requests/delete_bookmark_online_request.rb +8 -0
  35. data/lib/aspose_words_cloud/models/requests/delete_bookmark_request.rb +8 -0
  36. data/lib/aspose_words_cloud/models/requests/delete_bookmarks_online_request.rb +8 -0
  37. data/lib/aspose_words_cloud/models/requests/delete_bookmarks_request.rb +8 -0
  38. data/lib/aspose_words_cloud/models/requests/delete_border_online_request.rb +12 -0
  39. data/lib/aspose_words_cloud/models/requests/delete_border_request.rb +8 -0
  40. data/lib/aspose_words_cloud/models/requests/delete_borders_online_request.rb +12 -0
  41. data/lib/aspose_words_cloud/models/requests/delete_borders_request.rb +8 -0
  42. data/lib/aspose_words_cloud/models/requests/delete_comment_online_request.rb +8 -0
  43. data/lib/aspose_words_cloud/models/requests/delete_comment_request.rb +8 -0
  44. data/lib/aspose_words_cloud/models/requests/delete_comments_online_request.rb +8 -0
  45. data/lib/aspose_words_cloud/models/requests/delete_comments_request.rb +8 -0
  46. data/lib/aspose_words_cloud/models/requests/delete_custom_xml_part_online_request.rb +8 -0
  47. data/lib/aspose_words_cloud/models/requests/delete_custom_xml_part_request.rb +8 -0
  48. data/lib/aspose_words_cloud/models/requests/delete_custom_xml_parts_online_request.rb +8 -0
  49. data/lib/aspose_words_cloud/models/requests/delete_custom_xml_parts_request.rb +8 -0
  50. data/lib/aspose_words_cloud/models/requests/delete_document_property_online_request.rb +8 -0
  51. data/lib/aspose_words_cloud/models/requests/delete_document_property_request.rb +8 -0
  52. data/lib/aspose_words_cloud/models/requests/delete_drawing_object_online_request.rb +8 -0
  53. data/lib/aspose_words_cloud/models/requests/delete_drawing_object_request.rb +8 -0
  54. data/lib/aspose_words_cloud/models/requests/delete_field_online_request.rb +8 -0
  55. data/lib/aspose_words_cloud/models/requests/delete_field_request.rb +8 -0
  56. data/lib/aspose_words_cloud/models/requests/delete_fields_online_request.rb +8 -0
  57. data/lib/aspose_words_cloud/models/requests/delete_fields_request.rb +8 -0
  58. data/lib/aspose_words_cloud/models/requests/delete_file_request.rb +8 -0
  59. data/lib/aspose_words_cloud/models/requests/delete_folder_request.rb +8 -0
  60. data/lib/aspose_words_cloud/models/requests/delete_footnote_online_request.rb +8 -0
  61. data/lib/aspose_words_cloud/models/requests/delete_footnote_request.rb +8 -0
  62. data/lib/aspose_words_cloud/models/requests/delete_form_field_online_request.rb +8 -0
  63. data/lib/aspose_words_cloud/models/requests/delete_form_field_request.rb +8 -0
  64. data/lib/aspose_words_cloud/models/requests/delete_header_footer_online_request.rb +8 -0
  65. data/lib/aspose_words_cloud/models/requests/delete_header_footer_request.rb +8 -0
  66. data/lib/aspose_words_cloud/models/requests/delete_headers_footers_online_request.rb +8 -0
  67. data/lib/aspose_words_cloud/models/requests/delete_headers_footers_request.rb +8 -0
  68. data/lib/aspose_words_cloud/models/requests/delete_macros_online_request.rb +8 -0
  69. data/lib/aspose_words_cloud/models/requests/delete_macros_request.rb +8 -0
  70. data/lib/aspose_words_cloud/models/requests/delete_office_math_object_online_request.rb +8 -0
  71. data/lib/aspose_words_cloud/models/requests/delete_office_math_object_request.rb +8 -0
  72. data/lib/aspose_words_cloud/models/requests/delete_office_math_objects_online_request.rb +8 -0
  73. data/lib/aspose_words_cloud/models/requests/delete_office_math_objects_request.rb +8 -0
  74. data/lib/aspose_words_cloud/models/requests/delete_paragraph_list_format_online_request.rb +12 -0
  75. data/lib/aspose_words_cloud/models/requests/delete_paragraph_list_format_request.rb +8 -0
  76. data/lib/aspose_words_cloud/models/requests/delete_paragraph_online_request.rb +8 -0
  77. data/lib/aspose_words_cloud/models/requests/delete_paragraph_request.rb +8 -0
  78. data/lib/aspose_words_cloud/models/requests/delete_paragraph_tab_stop_online_request.rb +12 -0
  79. data/lib/aspose_words_cloud/models/requests/delete_paragraph_tab_stop_request.rb +8 -0
  80. data/lib/aspose_words_cloud/models/requests/delete_run_online_request.rb +8 -0
  81. data/lib/aspose_words_cloud/models/requests/delete_run_request.rb +8 -0
  82. data/lib/aspose_words_cloud/models/requests/delete_section_online_request.rb +8 -0
  83. data/lib/aspose_words_cloud/models/requests/delete_section_request.rb +8 -0
  84. data/lib/aspose_words_cloud/models/requests/delete_structured_document_tag_online_request.rb +8 -0
  85. data/lib/aspose_words_cloud/models/requests/delete_structured_document_tag_request.rb +8 -0
  86. data/lib/aspose_words_cloud/models/requests/delete_table_cell_online_request.rb +8 -0
  87. data/lib/aspose_words_cloud/models/requests/delete_table_cell_request.rb +8 -0
  88. data/lib/aspose_words_cloud/models/requests/delete_table_online_request.rb +8 -0
  89. data/lib/aspose_words_cloud/models/requests/delete_table_request.rb +8 -0
  90. data/lib/aspose_words_cloud/models/requests/delete_table_row_online_request.rb +8 -0
  91. data/lib/aspose_words_cloud/models/requests/delete_table_row_request.rb +8 -0
  92. data/lib/aspose_words_cloud/models/requests/delete_watermark_online_request.rb +12 -0
  93. data/lib/aspose_words_cloud/models/requests/delete_watermark_request.rb +8 -0
  94. data/lib/aspose_words_cloud/models/requests/download_file_request.rb +8 -0
  95. data/lib/aspose_words_cloud/models/requests/execute_mail_merge_job_request.rb +257 -0
  96. data/lib/aspose_words_cloud/models/requests/execute_mail_merge_online_job_request.rb +223 -0
  97. data/lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb +8 -0
  98. data/lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb +8 -0
  99. data/lib/aspose_words_cloud/models/requests/get_all_revisions_online_request.rb +8 -0
  100. data/lib/aspose_words_cloud/models/requests/get_all_revisions_request.rb +8 -0
  101. data/lib/aspose_words_cloud/models/requests/get_available_fonts_request.rb +8 -0
  102. data/lib/aspose_words_cloud/models/requests/get_bookmark_by_name_online_request.rb +8 -0
  103. data/lib/aspose_words_cloud/models/requests/get_bookmark_by_name_request.rb +8 -0
  104. data/lib/aspose_words_cloud/models/requests/get_bookmarks_online_request.rb +8 -0
  105. data/lib/aspose_words_cloud/models/requests/get_bookmarks_request.rb +8 -0
  106. data/lib/aspose_words_cloud/models/requests/get_border_online_request.rb +8 -0
  107. data/lib/aspose_words_cloud/models/requests/get_border_request.rb +8 -0
  108. data/lib/aspose_words_cloud/models/requests/get_borders_online_request.rb +8 -0
  109. data/lib/aspose_words_cloud/models/requests/get_borders_request.rb +8 -0
  110. data/lib/aspose_words_cloud/models/requests/get_comment_online_request.rb +8 -0
  111. data/lib/aspose_words_cloud/models/requests/get_comment_request.rb +8 -0
  112. data/lib/aspose_words_cloud/models/requests/get_comments_online_request.rb +8 -0
  113. data/lib/aspose_words_cloud/models/requests/get_comments_request.rb +8 -0
  114. data/lib/aspose_words_cloud/models/requests/get_custom_xml_part_online_request.rb +8 -0
  115. data/lib/aspose_words_cloud/models/requests/get_custom_xml_part_request.rb +8 -0
  116. data/lib/aspose_words_cloud/models/requests/get_custom_xml_parts_online_request.rb +8 -0
  117. data/lib/aspose_words_cloud/models/requests/get_custom_xml_parts_request.rb +8 -0
  118. data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_by_index_online_request.rb +8 -0
  119. data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_by_index_request.rb +8 -0
  120. data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_image_data_online_request.rb +8 -0
  121. data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_image_data_request.rb +8 -0
  122. data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_ole_data_online_request.rb +8 -0
  123. data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_ole_data_request.rb +8 -0
  124. data/lib/aspose_words_cloud/models/requests/get_document_drawing_objects_online_request.rb +8 -0
  125. data/lib/aspose_words_cloud/models/requests/get_document_drawing_objects_request.rb +8 -0
  126. data/lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb +8 -0
  127. data/lib/aspose_words_cloud/models/requests/get_document_field_names_request.rb +8 -0
  128. data/lib/aspose_words_cloud/models/requests/get_document_hyperlink_by_index_online_request.rb +8 -0
  129. data/lib/aspose_words_cloud/models/requests/get_document_hyperlink_by_index_request.rb +8 -0
  130. data/lib/aspose_words_cloud/models/requests/get_document_hyperlinks_online_request.rb +8 -0
  131. data/lib/aspose_words_cloud/models/requests/get_document_hyperlinks_request.rb +8 -0
  132. data/lib/aspose_words_cloud/models/requests/get_document_properties_online_request.rb +8 -0
  133. data/lib/aspose_words_cloud/models/requests/get_document_properties_request.rb +8 -0
  134. data/lib/aspose_words_cloud/models/requests/get_document_property_online_request.rb +8 -0
  135. data/lib/aspose_words_cloud/models/requests/get_document_property_request.rb +8 -0
  136. data/lib/aspose_words_cloud/models/requests/get_document_protection_online_request.rb +8 -0
  137. data/lib/aspose_words_cloud/models/requests/get_document_protection_request.rb +8 -0
  138. data/lib/aspose_words_cloud/models/requests/get_document_request.rb +8 -0
  139. data/lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb +8 -0
  140. data/lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb +8 -0
  141. data/lib/aspose_words_cloud/models/requests/get_document_with_format_request.rb +8 -0
  142. data/lib/aspose_words_cloud/models/requests/get_field_online_request.rb +8 -0
  143. data/lib/aspose_words_cloud/models/requests/get_field_request.rb +8 -0
  144. data/lib/aspose_words_cloud/models/requests/get_fields_online_request.rb +8 -0
  145. data/lib/aspose_words_cloud/models/requests/get_fields_request.rb +8 -0
  146. data/lib/aspose_words_cloud/models/requests/get_files_list_request.rb +8 -0
  147. data/lib/aspose_words_cloud/models/requests/get_footnote_online_request.rb +8 -0
  148. data/lib/aspose_words_cloud/models/requests/get_footnote_request.rb +8 -0
  149. data/lib/aspose_words_cloud/models/requests/get_footnotes_online_request.rb +8 -0
  150. data/lib/aspose_words_cloud/models/requests/get_footnotes_request.rb +8 -0
  151. data/lib/aspose_words_cloud/models/requests/get_form_field_online_request.rb +8 -0
  152. data/lib/aspose_words_cloud/models/requests/get_form_field_request.rb +8 -0
  153. data/lib/aspose_words_cloud/models/requests/get_form_fields_online_request.rb +8 -0
  154. data/lib/aspose_words_cloud/models/requests/get_form_fields_request.rb +8 -0
  155. data/lib/aspose_words_cloud/models/requests/get_header_footer_of_section_online_request.rb +8 -0
  156. data/lib/aspose_words_cloud/models/requests/get_header_footer_of_section_request.rb +8 -0
  157. data/lib/aspose_words_cloud/models/requests/get_header_footer_online_request.rb +8 -0
  158. data/lib/aspose_words_cloud/models/requests/get_header_footer_request.rb +8 -0
  159. data/lib/aspose_words_cloud/models/requests/get_header_footers_online_request.rb +8 -0
  160. data/lib/aspose_words_cloud/models/requests/get_header_footers_request.rb +8 -0
  161. data/lib/aspose_words_cloud/models/requests/get_info_request.rb +8 -0
  162. data/lib/aspose_words_cloud/models/requests/get_list_online_request.rb +8 -0
  163. data/lib/aspose_words_cloud/models/requests/get_list_request.rb +8 -0
  164. data/lib/aspose_words_cloud/models/requests/get_lists_online_request.rb +8 -0
  165. data/lib/aspose_words_cloud/models/requests/get_lists_request.rb +8 -0
  166. data/lib/aspose_words_cloud/models/requests/get_office_math_object_online_request.rb +8 -0
  167. data/lib/aspose_words_cloud/models/requests/get_office_math_object_request.rb +8 -0
  168. data/lib/aspose_words_cloud/models/requests/get_office_math_objects_online_request.rb +8 -0
  169. data/lib/aspose_words_cloud/models/requests/get_office_math_objects_request.rb +8 -0
  170. data/lib/aspose_words_cloud/models/requests/get_paragraph_format_online_request.rb +8 -0
  171. data/lib/aspose_words_cloud/models/requests/get_paragraph_format_request.rb +8 -0
  172. data/lib/aspose_words_cloud/models/requests/get_paragraph_list_format_online_request.rb +8 -0
  173. data/lib/aspose_words_cloud/models/requests/get_paragraph_list_format_request.rb +8 -0
  174. data/lib/aspose_words_cloud/models/requests/get_paragraph_online_request.rb +8 -0
  175. data/lib/aspose_words_cloud/models/requests/get_paragraph_request.rb +8 -0
  176. data/lib/aspose_words_cloud/models/requests/get_paragraph_tab_stops_online_request.rb +8 -0
  177. data/lib/aspose_words_cloud/models/requests/get_paragraph_tab_stops_request.rb +8 -0
  178. data/lib/aspose_words_cloud/models/requests/get_paragraphs_online_request.rb +8 -0
  179. data/lib/aspose_words_cloud/models/requests/get_paragraphs_request.rb +8 -0
  180. data/lib/aspose_words_cloud/models/requests/get_public_key_request.rb +8 -0
  181. data/lib/aspose_words_cloud/models/requests/get_range_text_online_request.rb +8 -0
  182. data/lib/aspose_words_cloud/models/requests/get_range_text_request.rb +8 -0
  183. data/lib/aspose_words_cloud/models/requests/get_run_font_online_request.rb +8 -0
  184. data/lib/aspose_words_cloud/models/requests/get_run_font_request.rb +8 -0
  185. data/lib/aspose_words_cloud/models/requests/get_run_online_request.rb +8 -0
  186. data/lib/aspose_words_cloud/models/requests/get_run_request.rb +8 -0
  187. data/lib/aspose_words_cloud/models/requests/get_runs_online_request.rb +8 -0
  188. data/lib/aspose_words_cloud/models/requests/get_runs_request.rb +8 -0
  189. data/lib/aspose_words_cloud/models/requests/get_section_online_request.rb +8 -0
  190. data/lib/aspose_words_cloud/models/requests/get_section_page_setup_online_request.rb +8 -0
  191. data/lib/aspose_words_cloud/models/requests/get_section_page_setup_request.rb +8 -0
  192. data/lib/aspose_words_cloud/models/requests/get_section_request.rb +8 -0
  193. data/lib/aspose_words_cloud/models/requests/get_sections_online_request.rb +8 -0
  194. data/lib/aspose_words_cloud/models/requests/get_sections_request.rb +8 -0
  195. data/lib/aspose_words_cloud/models/requests/get_signatures_online_request.rb +8 -0
  196. data/lib/aspose_words_cloud/models/requests/get_signatures_request.rb +8 -0
  197. data/lib/aspose_words_cloud/models/requests/get_structured_document_tag_online_request.rb +8 -0
  198. data/lib/aspose_words_cloud/models/requests/get_structured_document_tag_request.rb +8 -0
  199. data/lib/aspose_words_cloud/models/requests/get_structured_document_tags_online_request.rb +8 -0
  200. data/lib/aspose_words_cloud/models/requests/get_structured_document_tags_request.rb +8 -0
  201. data/lib/aspose_words_cloud/models/requests/get_style_from_document_element_online_request.rb +8 -0
  202. data/lib/aspose_words_cloud/models/requests/get_style_from_document_element_request.rb +8 -0
  203. data/lib/aspose_words_cloud/models/requests/get_style_online_request.rb +8 -0
  204. data/lib/aspose_words_cloud/models/requests/get_style_request.rb +8 -0
  205. data/lib/aspose_words_cloud/models/requests/get_styles_online_request.rb +8 -0
  206. data/lib/aspose_words_cloud/models/requests/get_styles_request.rb +8 -0
  207. data/lib/aspose_words_cloud/models/requests/get_table_cell_format_online_request.rb +8 -0
  208. data/lib/aspose_words_cloud/models/requests/get_table_cell_format_request.rb +8 -0
  209. data/lib/aspose_words_cloud/models/requests/get_table_cell_online_request.rb +8 -0
  210. data/lib/aspose_words_cloud/models/requests/get_table_cell_request.rb +8 -0
  211. data/lib/aspose_words_cloud/models/requests/get_table_online_request.rb +8 -0
  212. data/lib/aspose_words_cloud/models/requests/get_table_properties_online_request.rb +8 -0
  213. data/lib/aspose_words_cloud/models/requests/get_table_properties_request.rb +8 -0
  214. data/lib/aspose_words_cloud/models/requests/get_table_request.rb +8 -0
  215. data/lib/aspose_words_cloud/models/requests/get_table_row_format_online_request.rb +8 -0
  216. data/lib/aspose_words_cloud/models/requests/get_table_row_format_request.rb +8 -0
  217. data/lib/aspose_words_cloud/models/requests/get_table_row_online_request.rb +8 -0
  218. data/lib/aspose_words_cloud/models/requests/get_table_row_request.rb +8 -0
  219. data/lib/aspose_words_cloud/models/requests/get_tables_online_request.rb +8 -0
  220. data/lib/aspose_words_cloud/models/requests/get_tables_request.rb +8 -0
  221. data/lib/aspose_words_cloud/models/requests/insert_bookmark_online_request.rb +12 -0
  222. data/lib/aspose_words_cloud/models/requests/insert_bookmark_request.rb +8 -0
  223. data/lib/aspose_words_cloud/models/requests/insert_comment_online_request.rb +12 -0
  224. data/lib/aspose_words_cloud/models/requests/insert_comment_request.rb +8 -0
  225. data/lib/aspose_words_cloud/models/requests/insert_custom_xml_part_online_request.rb +12 -0
  226. data/lib/aspose_words_cloud/models/requests/insert_custom_xml_part_request.rb +8 -0
  227. data/lib/aspose_words_cloud/models/requests/insert_drawing_object_online_request.rb +12 -0
  228. data/lib/aspose_words_cloud/models/requests/insert_drawing_object_request.rb +8 -0
  229. data/lib/aspose_words_cloud/models/requests/insert_field_online_request.rb +12 -0
  230. data/lib/aspose_words_cloud/models/requests/insert_field_request.rb +8 -0
  231. data/lib/aspose_words_cloud/models/requests/insert_footnote_online_request.rb +12 -0
  232. data/lib/aspose_words_cloud/models/requests/insert_footnote_request.rb +8 -0
  233. data/lib/aspose_words_cloud/models/requests/insert_form_field_online_request.rb +12 -0
  234. data/lib/aspose_words_cloud/models/requests/insert_form_field_request.rb +8 -0
  235. data/lib/aspose_words_cloud/models/requests/insert_header_footer_online_request.rb +12 -0
  236. data/lib/aspose_words_cloud/models/requests/insert_header_footer_request.rb +8 -0
  237. data/lib/aspose_words_cloud/models/requests/insert_list_online_request.rb +12 -0
  238. data/lib/aspose_words_cloud/models/requests/insert_list_request.rb +8 -0
  239. data/lib/aspose_words_cloud/models/requests/insert_or_update_paragraph_tab_stop_online_request.rb +12 -0
  240. data/lib/aspose_words_cloud/models/requests/insert_or_update_paragraph_tab_stop_request.rb +8 -0
  241. data/lib/aspose_words_cloud/models/requests/insert_page_numbers_online_request.rb +12 -0
  242. data/lib/aspose_words_cloud/models/requests/insert_page_numbers_request.rb +8 -0
  243. data/lib/aspose_words_cloud/models/requests/insert_paragraph_online_request.rb +12 -0
  244. data/lib/aspose_words_cloud/models/requests/insert_paragraph_request.rb +8 -0
  245. data/lib/aspose_words_cloud/models/requests/insert_run_online_request.rb +12 -0
  246. data/lib/aspose_words_cloud/models/requests/insert_run_request.rb +8 -0
  247. data/lib/aspose_words_cloud/models/requests/insert_section_online_request.rb +8 -0
  248. data/lib/aspose_words_cloud/models/requests/insert_section_request.rb +8 -0
  249. data/lib/aspose_words_cloud/models/requests/insert_structured_document_tag_online_request.rb +12 -0
  250. data/lib/aspose_words_cloud/models/requests/insert_structured_document_tag_request.rb +8 -0
  251. data/lib/aspose_words_cloud/models/requests/insert_style_online_request.rb +12 -0
  252. data/lib/aspose_words_cloud/models/requests/insert_style_request.rb +8 -0
  253. data/lib/aspose_words_cloud/models/requests/insert_table_cell_online_request.rb +12 -0
  254. data/lib/aspose_words_cloud/models/requests/insert_table_cell_request.rb +8 -0
  255. data/lib/aspose_words_cloud/models/requests/insert_table_online_request.rb +12 -0
  256. data/lib/aspose_words_cloud/models/requests/insert_table_request.rb +8 -0
  257. data/lib/aspose_words_cloud/models/requests/insert_table_row_online_request.rb +12 -0
  258. data/lib/aspose_words_cloud/models/requests/insert_table_row_request.rb +8 -0
  259. data/lib/aspose_words_cloud/models/requests/insert_watermark_image_online_request.rb +12 -0
  260. data/lib/aspose_words_cloud/models/requests/insert_watermark_image_request.rb +8 -0
  261. data/lib/aspose_words_cloud/models/requests/insert_watermark_online_request.rb +12 -0
  262. data/lib/aspose_words_cloud/models/requests/insert_watermark_request.rb +8 -0
  263. data/lib/aspose_words_cloud/models/requests/insert_watermark_text_online_request.rb +12 -0
  264. data/lib/aspose_words_cloud/models/requests/insert_watermark_text_request.rb +8 -0
  265. data/lib/aspose_words_cloud/models/requests/link_header_footers_to_previous_request.rb +8 -0
  266. data/lib/aspose_words_cloud/models/requests/load_web_document_online_request.rb +12 -0
  267. data/lib/aspose_words_cloud/models/requests/load_web_document_request.rb +8 -0
  268. data/lib/aspose_words_cloud/models/requests/merge_with_next_online_request.rb +8 -0
  269. data/lib/aspose_words_cloud/models/requests/merge_with_next_request.rb +8 -0
  270. data/lib/aspose_words_cloud/models/requests/move_file_request.rb +8 -0
  271. data/lib/aspose_words_cloud/models/requests/move_folder_request.rb +8 -0
  272. data/lib/aspose_words_cloud/models/requests/optimize_document_online_request.rb +8 -0
  273. data/lib/aspose_words_cloud/models/requests/optimize_document_request.rb +8 -0
  274. data/lib/aspose_words_cloud/models/requests/protect_document_online_request.rb +12 -0
  275. data/lib/aspose_words_cloud/models/requests/protect_document_request.rb +8 -0
  276. data/lib/aspose_words_cloud/models/requests/reject_all_revisions_online_request.rb +12 -0
  277. data/lib/aspose_words_cloud/models/requests/reject_all_revisions_request.rb +8 -0
  278. data/lib/aspose_words_cloud/models/requests/remove_all_signatures_online_request.rb +12 -0
  279. data/lib/aspose_words_cloud/models/requests/remove_all_signatures_request.rb +8 -0
  280. data/lib/aspose_words_cloud/models/requests/remove_range_online_request.rb +12 -0
  281. data/lib/aspose_words_cloud/models/requests/remove_range_request.rb +8 -0
  282. data/lib/aspose_words_cloud/models/requests/render_drawing_object_online_request.rb +8 -0
  283. data/lib/aspose_words_cloud/models/requests/render_drawing_object_request.rb +8 -0
  284. data/lib/aspose_words_cloud/models/requests/render_math_object_online_request.rb +8 -0
  285. data/lib/aspose_words_cloud/models/requests/render_math_object_request.rb +8 -0
  286. data/lib/aspose_words_cloud/models/requests/render_page_online_request.rb +8 -0
  287. data/lib/aspose_words_cloud/models/requests/render_page_request.rb +8 -0
  288. data/lib/aspose_words_cloud/models/requests/render_paragraph_online_request.rb +8 -0
  289. data/lib/aspose_words_cloud/models/requests/render_paragraph_request.rb +8 -0
  290. data/lib/aspose_words_cloud/models/requests/render_table_online_request.rb +8 -0
  291. data/lib/aspose_words_cloud/models/requests/render_table_request.rb +8 -0
  292. data/lib/aspose_words_cloud/models/requests/replace_text_online_request.rb +12 -0
  293. data/lib/aspose_words_cloud/models/requests/replace_text_request.rb +8 -0
  294. data/lib/aspose_words_cloud/models/requests/replace_with_text_online_request.rb +12 -0
  295. data/lib/aspose_words_cloud/models/requests/replace_with_text_request.rb +8 -0
  296. data/lib/aspose_words_cloud/models/requests/reset_cache_request.rb +8 -0
  297. data/lib/aspose_words_cloud/models/requests/save_as_online_request.rb +12 -0
  298. data/lib/aspose_words_cloud/models/requests/save_as_range_online_request.rb +12 -0
  299. data/lib/aspose_words_cloud/models/requests/save_as_range_request.rb +8 -0
  300. data/lib/aspose_words_cloud/models/requests/save_as_request.rb +8 -0
  301. data/lib/aspose_words_cloud/models/requests/save_as_tiff_online_request.rb +12 -0
  302. data/lib/aspose_words_cloud/models/requests/save_as_tiff_request.rb +8 -0
  303. data/lib/aspose_words_cloud/models/requests/search_online_request.rb +8 -0
  304. data/lib/aspose_words_cloud/models/requests/search_request.rb +8 -0
  305. data/lib/aspose_words_cloud/models/requests/sign_document_online_request.rb +12 -0
  306. data/lib/aspose_words_cloud/models/requests/sign_document_request.rb +8 -0
  307. data/lib/aspose_words_cloud/models/requests/split_document_job_request.rb +232 -0
  308. data/lib/aspose_words_cloud/models/requests/split_document_online_job_request.rb +233 -0
  309. data/lib/aspose_words_cloud/models/requests/split_document_online_request.rb +12 -0
  310. data/lib/aspose_words_cloud/models/requests/split_document_request.rb +8 -0
  311. data/lib/aspose_words_cloud/models/requests/translate_node_id_online_request.rb +8 -0
  312. data/lib/aspose_words_cloud/models/requests/translate_node_id_request.rb +8 -0
  313. data/lib/aspose_words_cloud/models/requests/unprotect_document_online_request.rb +12 -0
  314. data/lib/aspose_words_cloud/models/requests/unprotect_document_request.rb +8 -0
  315. data/lib/aspose_words_cloud/models/requests/update_bookmark_online_request.rb +12 -0
  316. data/lib/aspose_words_cloud/models/requests/update_bookmark_request.rb +8 -0
  317. data/lib/aspose_words_cloud/models/requests/update_border_online_request.rb +12 -0
  318. data/lib/aspose_words_cloud/models/requests/update_border_request.rb +8 -0
  319. data/lib/aspose_words_cloud/models/requests/update_comment_online_request.rb +12 -0
  320. data/lib/aspose_words_cloud/models/requests/update_comment_request.rb +8 -0
  321. data/lib/aspose_words_cloud/models/requests/update_custom_xml_part_online_request.rb +12 -0
  322. data/lib/aspose_words_cloud/models/requests/update_custom_xml_part_request.rb +8 -0
  323. data/lib/aspose_words_cloud/models/requests/update_drawing_object_online_request.rb +12 -0
  324. data/lib/aspose_words_cloud/models/requests/update_drawing_object_request.rb +8 -0
  325. data/lib/aspose_words_cloud/models/requests/update_field_online_request.rb +12 -0
  326. data/lib/aspose_words_cloud/models/requests/update_field_request.rb +8 -0
  327. data/lib/aspose_words_cloud/models/requests/update_fields_online_request.rb +12 -0
  328. data/lib/aspose_words_cloud/models/requests/update_fields_request.rb +8 -0
  329. data/lib/aspose_words_cloud/models/requests/update_footnote_online_request.rb +12 -0
  330. data/lib/aspose_words_cloud/models/requests/update_footnote_request.rb +8 -0
  331. data/lib/aspose_words_cloud/models/requests/update_form_field_online_request.rb +12 -0
  332. data/lib/aspose_words_cloud/models/requests/update_form_field_request.rb +8 -0
  333. data/lib/aspose_words_cloud/models/requests/update_list_level_online_request.rb +12 -0
  334. data/lib/aspose_words_cloud/models/requests/update_list_level_request.rb +8 -0
  335. data/lib/aspose_words_cloud/models/requests/update_list_online_request.rb +12 -0
  336. data/lib/aspose_words_cloud/models/requests/update_list_request.rb +8 -0
  337. data/lib/aspose_words_cloud/models/requests/update_paragraph_format_online_request.rb +12 -0
  338. data/lib/aspose_words_cloud/models/requests/update_paragraph_format_request.rb +8 -0
  339. data/lib/aspose_words_cloud/models/requests/update_paragraph_list_format_online_request.rb +12 -0
  340. data/lib/aspose_words_cloud/models/requests/update_paragraph_list_format_request.rb +8 -0
  341. data/lib/aspose_words_cloud/models/requests/update_run_font_online_request.rb +12 -0
  342. data/lib/aspose_words_cloud/models/requests/update_run_font_request.rb +8 -0
  343. data/lib/aspose_words_cloud/models/requests/update_run_online_request.rb +12 -0
  344. data/lib/aspose_words_cloud/models/requests/update_run_request.rb +8 -0
  345. data/lib/aspose_words_cloud/models/requests/update_section_page_setup_online_request.rb +12 -0
  346. data/lib/aspose_words_cloud/models/requests/update_section_page_setup_request.rb +8 -0
  347. data/lib/aspose_words_cloud/models/requests/update_structured_document_tag_online_request.rb +12 -0
  348. data/lib/aspose_words_cloud/models/requests/update_structured_document_tag_request.rb +8 -0
  349. data/lib/aspose_words_cloud/models/requests/update_style_online_request.rb +12 -0
  350. data/lib/aspose_words_cloud/models/requests/update_style_request.rb +8 -0
  351. data/lib/aspose_words_cloud/models/requests/update_table_cell_format_online_request.rb +12 -0
  352. data/lib/aspose_words_cloud/models/requests/update_table_cell_format_request.rb +8 -0
  353. data/lib/aspose_words_cloud/models/requests/update_table_properties_online_request.rb +12 -0
  354. data/lib/aspose_words_cloud/models/requests/update_table_properties_request.rb +8 -0
  355. data/lib/aspose_words_cloud/models/requests/update_table_row_format_online_request.rb +12 -0
  356. data/lib/aspose_words_cloud/models/requests/update_table_row_format_request.rb +8 -0
  357. data/lib/aspose_words_cloud/models/requests/upload_file_request.rb +8 -0
  358. data/lib/aspose_words_cloud/version.rb +1 -1
  359. data/lib/aspose_words_cloud.rb +9 -0
  360. metadata +11 -2
@@ -0,0 +1,257 @@
1
+ # ------------------------------------------------------------------------------------
2
+ # <copyright company="Aspose" file="execute_mail_merge_job_request.rb">
3
+ # Copyright (c) 2026 Aspose.Words for Cloud
4
+ # </copyright>
5
+ # <summary>
6
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ # of this software and associated documentation files (the "Software"), to deal
8
+ # in the Software without restriction, including without limitation the rights
9
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ # copies of the Software, and to permit persons to whom the Software is
11
+ # furnished to do so, subject to the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be included in all
14
+ # copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ # SOFTWARE.
23
+ # </summary>
24
+ # ------------------------------------------------------------------------------------
25
+
26
+ module AsposeWordsCloud
27
+
28
+ #
29
+ # Request model for execute_mail_merge_job operation.
30
+ #
31
+ class ExecuteMailMergeJobRequest
32
+ # The filename of the input document.
33
+ attr_accessor :name
34
+
35
+ # Mail merge data.
36
+ attr_accessor :data
37
+
38
+ # Field options.
39
+ attr_accessor :options
40
+
41
+ # Original document folder.
42
+ attr_accessor :folder
43
+
44
+ # Original document storage.
45
+ attr_accessor :storage
46
+
47
+ # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
48
+ attr_accessor :load_encoding
49
+
50
+ # Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
51
+ attr_accessor :password
52
+
53
+ # Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
54
+ attr_accessor :encrypted_password
55
+
56
+ # The value indicates whether OpenType support is on.
57
+ attr_accessor :open_type_support
58
+
59
+ # The flag indicating whether to execute Mail Merge operation with regions.
60
+ attr_accessor :with_regions
61
+
62
+ # The data file.
63
+ attr_accessor :mail_merge_data_file
64
+
65
+ # The cleanup options.
66
+ attr_accessor :cleanup
67
+
68
+ # The flag indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.
69
+ attr_accessor :use_whole_paragraph_as_region
70
+
71
+ # The flag indicating whether fields in whole document are updated while executing of a mail merge with regions.
72
+ attr_accessor :merge_whole_document
73
+
74
+ # The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
75
+ attr_accessor :dest_file_name
76
+
77
+ #
78
+ # Initializes a new instance.
79
+ # @param name The filename of the input document.
80
+ # @param data Mail merge data.
81
+ # @param options Field options.
82
+ # @param folder Original document folder.
83
+ # @param storage Original document storage.
84
+ # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
85
+ # @param password Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
86
+ # @param encrypted_password Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
87
+ # @param open_type_support The value indicates whether OpenType support is on.
88
+ # @param with_regions The flag indicating whether to execute Mail Merge operation with regions.
89
+ # @param mail_merge_data_file The data file.
90
+ # @param cleanup The cleanup options.
91
+ # @param use_whole_paragraph_as_region The flag indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.
92
+ # @param merge_whole_document The flag indicating whether fields in whole document are updated while executing of a mail merge with regions.
93
+ # @param dest_file_name The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
94
+
95
+ def initialize(name:, data: nil, options: nil, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, with_regions: nil, mail_merge_data_file: nil, cleanup: nil, use_whole_paragraph_as_region: nil, merge_whole_document: nil, dest_file_name: nil)
96
+ self.name = name
97
+ self.data = data
98
+ self.options = options
99
+ self.folder = folder
100
+ self.storage = storage
101
+ self.load_encoding = load_encoding
102
+ self.password = password
103
+ self.encrypted_password = encrypted_password
104
+ self.open_type_support = open_type_support
105
+ self.with_regions = with_regions
106
+ self.mail_merge_data_file = mail_merge_data_file
107
+ self.cleanup = cleanup
108
+ self.use_whole_paragraph_as_region = use_whole_paragraph_as_region
109
+ self.merge_whole_document = merge_whole_document
110
+ self.dest_file_name = dest_file_name
111
+ end
112
+
113
+ def get_original_request
114
+ ExecuteMailMergeRequest.new(name: self.name, data: self.data, options: self.options, folder: self.folder, storage: self.storage, load_encoding: self.load_encoding, password: self.password, encrypted_password: self.encrypted_password, open_type_support: self.open_type_support, with_regions: self.with_regions, mail_merge_data_file: self.mail_merge_data_file, cleanup: self.cleanup, use_whole_paragraph_as_region: self.use_whole_paragraph_as_region, merge_whole_document: self.merge_whole_document, dest_file_name: self.dest_file_name)
115
+ end
116
+
117
+ # Creating batch part from request
118
+ def to_batch_part(api_client, requestId, parentRequestId = nil)
119
+ # verify the required parameter 'name' is set
120
+ raise ArgumentError, 'Missing the required parameter name when calling WordsApi.execute_mail_merge_job' if api_client.config.client_side_validation && self.name.nil?
121
+ self.options&.validate
122
+ # resource path
123
+ local_var_path = '/words/job/put/{name}/MailMerge'[7..-1]
124
+ local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
125
+ local_var_path = local_var_path.sub('//', '/')
126
+
127
+ # query parameters
128
+ query_params = {}
129
+ query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
130
+ query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
131
+ query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
132
+ query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
133
+ query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
134
+ query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
135
+ query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
136
+ query_params[downcase_first_letter('MailMergeDataFile')] = self.mail_merge_data_file unless self.mail_merge_data_file.nil?
137
+ query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
138
+ query_params[downcase_first_letter('UseWholeParagraphAsRegion')] = self.use_whole_paragraph_as_region unless self.use_whole_paragraph_as_region.nil?
139
+ query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
140
+ query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
141
+
142
+ if query_params
143
+ query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
144
+ end
145
+
146
+ header_params = {}
147
+ # header parameters
148
+ # HTTP header 'Content-Type'
149
+ header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
150
+ header_params['RequestId'] = requestId
151
+
152
+ if parentRequestId != nil
153
+ header_params['DependsOn'] = parentRequestId
154
+ end
155
+
156
+ # form parameters
157
+ form_params = []
158
+ files_content = []
159
+ unless self.data.nil?
160
+ form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'text/plain'})
161
+ end
162
+
163
+ unless self.options.nil?
164
+ form_params.push({:'Name' => 'options', :'Data' => self.options.to_body.to_json, :'MimeType' =>'application/json'})
165
+ end
166
+
167
+
168
+ # http body (model)
169
+ body = api_client.build_request_body_batch(header_params, form_params, files_content)
170
+ part = ""
171
+ part.concat("PUT".force_encoding('UTF-8'))
172
+ part.concat(" ".force_encoding('UTF-8'))
173
+ part.concat(local_var_path.force_encoding('UTF-8'))
174
+ part.concat(" \r\n".force_encoding('UTF-8'))
175
+
176
+ header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
177
+ part.concat("\r\n".force_encoding('UTF-8'))
178
+ if body
179
+ if body.is_a?(Hash)
180
+ body.each do |key, value|
181
+ part.concat(value, "\r\n")
182
+ end
183
+ else
184
+ part.concat(body)
185
+ end
186
+ end
187
+ part
188
+ end
189
+
190
+ def create_http_request(api_client)
191
+ # verify the required parameter 'name' is set
192
+ raise ArgumentError, 'Missing the required parameter name when calling WordsApi.execute_mail_merge_job' if api_client.config.client_side_validation && self.name.nil?
193
+ self.options&.validate
194
+ # resource path
195
+ local_var_path = '/words/job/put/{name}/MailMerge'[1..-1]
196
+ local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
197
+ local_var_path = local_var_path.sub('//', '/')
198
+
199
+ # query parameters
200
+ query_params = {}
201
+ query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
202
+ query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
203
+ query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
204
+ query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
205
+ query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
206
+ query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
207
+ query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
208
+ query_params[downcase_first_letter('MailMergeDataFile')] = self.mail_merge_data_file unless self.mail_merge_data_file.nil?
209
+ query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
210
+ query_params[downcase_first_letter('UseWholeParagraphAsRegion')] = self.use_whole_paragraph_as_region unless self.use_whole_paragraph_as_region.nil?
211
+ query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
212
+ query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
213
+
214
+ # header parameters
215
+ header_params = {}
216
+ # HTTP header 'Content-Type'
217
+ header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
218
+
219
+ # form parameters
220
+ form_params = []
221
+ files_content = []
222
+ unless self.data.nil?
223
+ form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'text/plain'})
224
+ end
225
+
226
+ unless self.options.nil?
227
+ form_params.push({:'Name' => 'options', :'Data' => self.options.to_body.to_json, :'MimeType' =>'application/json'})
228
+ end
229
+
230
+ body = api_client.build_request_body(header_params, form_params, files_content)
231
+ {
232
+ 'method': :PUT,
233
+ 'path': local_var_path,
234
+ 'header_params': header_params,
235
+ 'query_params': query_params,
236
+ 'body': body,
237
+ 'auth_names': ['JWT']
238
+ }
239
+ end
240
+
241
+ #
242
+ # Helper method to convert first letter to downcase
243
+ #
244
+ def downcase_first_letter(str)
245
+ str[0].downcase + str[1..-1]
246
+ end
247
+
248
+ # Get response type
249
+ def get_response_type
250
+ 'JobInfo'
251
+ end
252
+
253
+ def deserialize_response(api_client, body, headers)
254
+ api_client.deserialize(body, headers, 'JobInfo')
255
+ end
256
+ end
257
+ end
@@ -0,0 +1,223 @@
1
+ # ------------------------------------------------------------------------------------
2
+ # <copyright company="Aspose" file="execute_mail_merge_online_job_request.rb">
3
+ # Copyright (c) 2026 Aspose.Words for Cloud
4
+ # </copyright>
5
+ # <summary>
6
+ # Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ # of this software and associated documentation files (the "Software"), to deal
8
+ # in the Software without restriction, including without limitation the rights
9
+ # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ # copies of the Software, and to permit persons to whom the Software is
11
+ # furnished to do so, subject to the following conditions:
12
+ #
13
+ # The above copyright notice and this permission notice shall be included in all
14
+ # copies or substantial portions of the Software.
15
+ #
16
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ # SOFTWARE.
23
+ # </summary>
24
+ # ------------------------------------------------------------------------------------
25
+
26
+ module AsposeWordsCloud
27
+
28
+ #
29
+ # Request model for execute_mail_merge_online_job operation.
30
+ #
31
+ class ExecuteMailMergeOnlineJobRequest
32
+ # File with template.
33
+ attr_accessor :template
34
+
35
+ # File with mailmerge data.
36
+ attr_accessor :data
37
+
38
+ # Field options.
39
+ attr_accessor :options
40
+
41
+ # The flag indicating whether to execute Mail Merge operation with regions.
42
+ attr_accessor :with_regions
43
+
44
+ # The flag indicating whether fields in whole document are updated while executing of a mail merge with regions.
45
+ attr_accessor :merge_whole_document
46
+
47
+ # The cleanup options.
48
+ attr_accessor :cleanup
49
+
50
+ # The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "template" will be used instead.
51
+ attr_accessor :document_file_name
52
+
53
+ #
54
+ # Initializes a new instance.
55
+ # @param template File with template.
56
+ # @param data File with mailmerge data.
57
+ # @param options Field options.
58
+ # @param with_regions The flag indicating whether to execute Mail Merge operation with regions.
59
+ # @param merge_whole_document The flag indicating whether fields in whole document are updated while executing of a mail merge with regions.
60
+ # @param cleanup The cleanup options.
61
+ # @param document_file_name The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "template" will be used instead.
62
+
63
+ def initialize(template:, data:, options: nil, with_regions: nil, merge_whole_document: nil, cleanup: nil, document_file_name: nil)
64
+ self.template = template
65
+ self.data = data
66
+ self.options = options
67
+ self.with_regions = with_regions
68
+ self.merge_whole_document = merge_whole_document
69
+ self.cleanup = cleanup
70
+ self.document_file_name = document_file_name
71
+ end
72
+
73
+ def get_original_request
74
+ ExecuteMailMergeOnlineRequest.new(template: self.template, data: self.data, options: self.options, with_regions: self.with_regions, merge_whole_document: self.merge_whole_document, cleanup: self.cleanup, document_file_name: self.document_file_name)
75
+ end
76
+
77
+ # Creating batch part from request
78
+ def to_batch_part(api_client, requestId, parentRequestId = nil)
79
+ # verify the required parameter 'template' is set
80
+ raise ArgumentError, 'Missing the required parameter template when calling WordsApi.execute_mail_merge_online_job' if api_client.config.client_side_validation && self.template.nil?
81
+ # verify the required parameter 'data' is set
82
+ raise ArgumentError, 'Missing the required parameter data when calling WordsApi.execute_mail_merge_online_job' if api_client.config.client_side_validation && self.data.nil?
83
+ self.options&.validate
84
+ # resource path
85
+ local_var_path = '/words/job/put/MailMerge'[7..-1]
86
+ local_var_path = local_var_path.sub('//', '/')
87
+
88
+ # query parameters
89
+ query_params = {}
90
+ query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
91
+ query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
92
+ query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
93
+ query_params[downcase_first_letter('DocumentFileName')] = self.document_file_name unless self.document_file_name.nil?
94
+
95
+ if query_params
96
+ query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
97
+ end
98
+
99
+ header_params = {}
100
+ # header parameters
101
+ # HTTP header 'Content-Type'
102
+ header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
103
+ header_params['RequestId'] = requestId
104
+
105
+ if parentRequestId != nil
106
+ header_params['DependsOn'] = parentRequestId
107
+ end
108
+
109
+ # form parameters
110
+ form_params = []
111
+ files_content = []
112
+ if self.template.nil?
113
+ raise "Parameter Template is required."
114
+ end
115
+ unless self.template.nil?
116
+ form_params.push({:'Name' => 'template', :'Data' => self.template, :'MimeType' =>'application/octet-stream'})
117
+ end
118
+
119
+ if self.data.nil?
120
+ raise "Parameter Data is required."
121
+ end
122
+ unless self.data.nil?
123
+ form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'application/octet-stream'})
124
+ end
125
+
126
+ unless self.options.nil?
127
+ form_params.push({:'Name' => 'options', :'Data' => self.options.to_body.to_json, :'MimeType' =>'application/json'})
128
+ end
129
+
130
+
131
+ # http body (model)
132
+ body = api_client.build_request_body_batch(header_params, form_params, files_content)
133
+ part = ""
134
+ part.concat("PUT".force_encoding('UTF-8'))
135
+ part.concat(" ".force_encoding('UTF-8'))
136
+ part.concat(local_var_path.force_encoding('UTF-8'))
137
+ part.concat(" \r\n".force_encoding('UTF-8'))
138
+
139
+ header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
140
+ part.concat("\r\n".force_encoding('UTF-8'))
141
+ if body
142
+ if body.is_a?(Hash)
143
+ body.each do |key, value|
144
+ part.concat(value, "\r\n")
145
+ end
146
+ else
147
+ part.concat(body)
148
+ end
149
+ end
150
+ part
151
+ end
152
+
153
+ def create_http_request(api_client)
154
+ # verify the required parameter 'template' is set
155
+ raise ArgumentError, 'Missing the required parameter template when calling WordsApi.execute_mail_merge_online_job' if api_client.config.client_side_validation && self.template.nil?
156
+ # verify the required parameter 'data' is set
157
+ raise ArgumentError, 'Missing the required parameter data when calling WordsApi.execute_mail_merge_online_job' if api_client.config.client_side_validation && self.data.nil?
158
+ self.options&.validate
159
+ # resource path
160
+ local_var_path = '/words/job/put/MailMerge'[1..-1]
161
+ local_var_path = local_var_path.sub('//', '/')
162
+
163
+ # query parameters
164
+ query_params = {}
165
+ query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
166
+ query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
167
+ query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
168
+ query_params[downcase_first_letter('DocumentFileName')] = self.document_file_name unless self.document_file_name.nil?
169
+
170
+ # header parameters
171
+ header_params = {}
172
+ # HTTP header 'Content-Type'
173
+ header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
174
+
175
+ # form parameters
176
+ form_params = []
177
+ files_content = []
178
+ if self.template.nil?
179
+ raise "Parameter Template is required."
180
+ end
181
+ unless self.template.nil?
182
+ form_params.push({:'Name' => 'template', :'Data' => self.template, :'MimeType' =>'application/octet-stream'})
183
+ end
184
+
185
+ if self.data.nil?
186
+ raise "Parameter Data is required."
187
+ end
188
+ unless self.data.nil?
189
+ form_params.push({:'Name' => 'data', :'Data' => self.data, :'MimeType' =>'application/octet-stream'})
190
+ end
191
+
192
+ unless self.options.nil?
193
+ form_params.push({:'Name' => 'options', :'Data' => self.options.to_body.to_json, :'MimeType' =>'application/json'})
194
+ end
195
+
196
+ body = api_client.build_request_body(header_params, form_params, files_content)
197
+ {
198
+ 'method': :PUT,
199
+ 'path': local_var_path,
200
+ 'header_params': header_params,
201
+ 'query_params': query_params,
202
+ 'body': body,
203
+ 'auth_names': ['JWT']
204
+ }
205
+ end
206
+
207
+ #
208
+ # Helper method to convert first letter to downcase
209
+ #
210
+ def downcase_first_letter(str)
211
+ str[0].downcase + str[1..-1]
212
+ end
213
+
214
+ # Get response type
215
+ def get_response_type
216
+ 'JobInfo'
217
+ end
218
+
219
+ def deserialize_response(api_client, body, headers)
220
+ api_client.deserialize(body, headers, 'JobInfo')
221
+ end
222
+ end
223
+ end
@@ -70,6 +70,10 @@ module AsposeWordsCloud
70
70
  self.document_file_name = document_file_name
71
71
  end
72
72
 
73
+ def get_original_request
74
+ self
75
+ end
76
+
73
77
  # Creating batch part from request
74
78
  def to_batch_part(api_client, requestId, parentRequestId = nil)
75
79
  # verify the required parameter 'template' is set
@@ -211,5 +215,9 @@ module AsposeWordsCloud
211
215
  def get_response_type
212
216
  'File'
213
217
  end
218
+
219
+ def deserialize_response(api_client, body, headers)
220
+ api_client.deserialize(body, headers, 'File')
221
+ end
214
222
  end
215
223
  end
@@ -110,6 +110,10 @@ module AsposeWordsCloud
110
110
  self.dest_file_name = dest_file_name
111
111
  end
112
112
 
113
+ def get_original_request
114
+ self
115
+ end
116
+
113
117
  # Creating batch part from request
114
118
  def to_batch_part(api_client, requestId, parentRequestId = nil)
115
119
  # verify the required parameter 'name' is set
@@ -245,5 +249,9 @@ module AsposeWordsCloud
245
249
  def get_response_type
246
250
  'DocumentResponse'
247
251
  end
252
+
253
+ def deserialize_response(api_client, body, headers)
254
+ api_client.deserialize(body, headers, 'DocumentResponse')
255
+ end
248
256
  end
249
257
  end
@@ -60,6 +60,10 @@ module AsposeWordsCloud
60
60
  self.open_type_support = open_type_support
61
61
  end
62
62
 
63
+ def get_original_request
64
+ self
65
+ end
66
+
63
67
  # Creating batch part from request
64
68
  def to_batch_part(api_client, requestId, parentRequestId = nil)
65
69
  # verify the required parameter 'document' is set
@@ -175,5 +179,9 @@ module AsposeWordsCloud
175
179
  def get_response_type
176
180
  'RevisionsResponse'
177
181
  end
182
+
183
+ def deserialize_response(api_client, body, headers)
184
+ api_client.deserialize(body, headers, 'RevisionsResponse')
185
+ end
178
186
  end
179
187
  end
@@ -70,6 +70,10 @@ module AsposeWordsCloud
70
70
  self.open_type_support = open_type_support
71
71
  end
72
72
 
73
+ def get_original_request
74
+ self
75
+ end
76
+
73
77
  # Creating batch part from request
74
78
  def to_batch_part(api_client, requestId, parentRequestId = nil)
75
79
  # verify the required parameter 'name' is set
@@ -174,5 +178,9 @@ module AsposeWordsCloud
174
178
  def get_response_type
175
179
  'RevisionsResponse'
176
180
  end
181
+
182
+ def deserialize_response(api_client, body, headers)
183
+ api_client.deserialize(body, headers, 'RevisionsResponse')
184
+ end
177
185
  end
178
186
  end
@@ -40,6 +40,10 @@ module AsposeWordsCloud
40
40
  self.fonts_location = fonts_location
41
41
  end
42
42
 
43
+ def get_original_request
44
+ self
45
+ end
46
+
43
47
  # Creating batch part from request
44
48
  def to_batch_part(api_client, requestId, parentRequestId = nil)
45
49
  # resource path
@@ -126,5 +130,9 @@ module AsposeWordsCloud
126
130
  def get_response_type
127
131
  'AvailableFontsResponse'
128
132
  end
133
+
134
+ def deserialize_response(api_client, body, headers)
135
+ api_client.deserialize(body, headers, 'AvailableFontsResponse')
136
+ end
129
137
  end
130
138
  end
@@ -65,6 +65,10 @@ module AsposeWordsCloud
65
65
  self.open_type_support = open_type_support
66
66
  end
67
67
 
68
+ def get_original_request
69
+ self
70
+ end
71
+
68
72
  # Creating batch part from request
69
73
  def to_batch_part(api_client, requestId, parentRequestId = nil)
70
74
  # verify the required parameter 'document' is set
@@ -186,5 +190,9 @@ module AsposeWordsCloud
186
190
  def get_response_type
187
191
  'BookmarkResponse'
188
192
  end
193
+
194
+ def deserialize_response(api_client, body, headers)
195
+ api_client.deserialize(body, headers, 'BookmarkResponse')
196
+ end
189
197
  end
190
198
  end
@@ -75,6 +75,10 @@ module AsposeWordsCloud
75
75
  self.open_type_support = open_type_support
76
76
  end
77
77
 
78
+ def get_original_request
79
+ self
80
+ end
81
+
78
82
  # Creating batch part from request
79
83
  def to_batch_part(api_client, requestId, parentRequestId = nil)
80
84
  # verify the required parameter 'name' is set
@@ -185,5 +189,9 @@ module AsposeWordsCloud
185
189
  def get_response_type
186
190
  'BookmarkResponse'
187
191
  end
192
+
193
+ def deserialize_response(api_client, body, headers)
194
+ api_client.deserialize(body, headers, 'BookmarkResponse')
195
+ end
188
196
  end
189
197
  end
@@ -60,6 +60,10 @@ module AsposeWordsCloud
60
60
  self.open_type_support = open_type_support
61
61
  end
62
62
 
63
+ def get_original_request
64
+ self
65
+ end
66
+
63
67
  # Creating batch part from request
64
68
  def to_batch_part(api_client, requestId, parentRequestId = nil)
65
69
  # verify the required parameter 'document' is set
@@ -175,5 +179,9 @@ module AsposeWordsCloud
175
179
  def get_response_type
176
180
  'BookmarksResponse'
177
181
  end
182
+
183
+ def deserialize_response(api_client, body, headers)
184
+ api_client.deserialize(body, headers, 'BookmarksResponse')
185
+ end
178
186
  end
179
187
  end
@@ -70,6 +70,10 @@ module AsposeWordsCloud
70
70
  self.open_type_support = open_type_support
71
71
  end
72
72
 
73
+ def get_original_request
74
+ self
75
+ end
76
+
73
77
  # Creating batch part from request
74
78
  def to_batch_part(api_client, requestId, parentRequestId = nil)
75
79
  # verify the required parameter 'name' is set
@@ -174,5 +178,9 @@ module AsposeWordsCloud
174
178
  def get_response_type
175
179
  'BookmarksResponse'
176
180
  end
181
+
182
+ def deserialize_response(api_client, body, headers)
183
+ api_client.deserialize(body, headers, 'BookmarksResponse')
184
+ end
177
185
  end
178
186
  end