aspose_words_cloud 24.8.0 → 24.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aspose_words_cloud/api/words_api.rb +260 -0
- data/lib/aspose_words_cloud/models/azw3_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/digital_signature_details.rb +218 -0
- data/lib/aspose_words_cloud/models/epub_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/html_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/mhtml_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/open_xps_save_options_data.rb +14 -1
- data/lib/aspose_words_cloud/models/pdf_save_options_data.rb +13 -1
- data/lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb +8 -1
- data/lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb +8 -1
- data/lib/aspose_words_cloud/models/requests/get_signatures_online_request.rb +179 -0
- data/lib/aspose_words_cloud/models/requests/get_signatures_request.rb +178 -0
- data/lib/aspose_words_cloud/models/requests/remove_all_signatures_online_request.rb +186 -0
- data/lib/aspose_words_cloud/models/requests/remove_all_signatures_request.rb +185 -0
- data/lib/aspose_words_cloud/models/requests/sign_document_online_request.rb +208 -0
- data/lib/aspose_words_cloud/models/requests/sign_document_request.rb +207 -0
- data/lib/aspose_words_cloud/models/responses/remove_all_signatures_online_response.rb +47 -0
- data/lib/aspose_words_cloud/models/responses/sign_document_online_response.rb +47 -0
- data/lib/aspose_words_cloud/models/sign_options.rb +254 -0
- data/lib/aspose_words_cloud/models/signature.rb +267 -0
- data/lib/aspose_words_cloud/models/signature_collection_response.rb +236 -0
- data/lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/xaml_flow_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/xps_save_options_data.rb +14 -1
- data/lib/aspose_words_cloud/version.rb +1 -1
- data/lib/aspose_words_cloud.rb +10 -0
- metadata +14 -2
@@ -192,6 +192,13 @@ module AsposeWordsCloud
|
|
192
192
|
# Gets or sets a value indicating whether to use pretty formats output.
|
193
193
|
attr_accessor :pretty_format
|
194
194
|
|
195
|
+
# Gets or sets the flag that indicates whether backslash characters should be replaced with yen signs.
|
196
|
+
# Default value is false.
|
197
|
+
# By default, Aspose.Words mimics MS Word's behavior and doesn't replace backslash characters with yen signs in
|
198
|
+
# generated HTML documents. However, previous versions of Aspose.Words performed such replacements in certain
|
199
|
+
# scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
|
200
|
+
attr_accessor :replace_backslash_with_yen_sign
|
201
|
+
|
195
202
|
# Gets or sets a value indicating whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats.
|
196
203
|
# The default value is false.
|
197
204
|
attr_accessor :resolve_font_names
|
@@ -281,6 +288,7 @@ module AsposeWordsCloud
|
|
281
288
|
:'metafile_format' => :'MetafileFormat',
|
282
289
|
:'office_math_output_mode' => :'OfficeMathOutputMode',
|
283
290
|
:'pretty_format' => :'PrettyFormat',
|
291
|
+
:'replace_backslash_with_yen_sign' => :'ReplaceBackslashWithYenSign',
|
284
292
|
:'resolve_font_names' => :'ResolveFontNames',
|
285
293
|
:'resource_folder' => :'ResourceFolder',
|
286
294
|
:'resource_folder_alias' => :'ResourceFolderAlias',
|
@@ -338,6 +346,7 @@ module AsposeWordsCloud
|
|
338
346
|
:'metafile_format' => :'String',
|
339
347
|
:'office_math_output_mode' => :'String',
|
340
348
|
:'pretty_format' => :'BOOLEAN',
|
349
|
+
:'replace_backslash_with_yen_sign' => :'BOOLEAN',
|
341
350
|
:'resolve_font_names' => :'BOOLEAN',
|
342
351
|
:'resource_folder' => :'String',
|
343
352
|
:'resource_folder_alias' => :'String',
|
@@ -537,6 +546,10 @@ module AsposeWordsCloud
|
|
537
546
|
self.pretty_format = attributes[:'PrettyFormat']
|
538
547
|
end
|
539
548
|
|
549
|
+
if attributes.key?(:'ReplaceBackslashWithYenSign')
|
550
|
+
self.replace_backslash_with_yen_sign = attributes[:'ReplaceBackslashWithYenSign']
|
551
|
+
end
|
552
|
+
|
540
553
|
if attributes.key?(:'ResolveFontNames')
|
541
554
|
self.resolve_font_names = attributes[:'ResolveFontNames']
|
542
555
|
end
|
@@ -808,6 +821,7 @@ module AsposeWordsCloud
|
|
808
821
|
metafile_format == other.metafile_format &&
|
809
822
|
office_math_output_mode == other.office_math_output_mode &&
|
810
823
|
pretty_format == other.pretty_format &&
|
824
|
+
replace_backslash_with_yen_sign == other.replace_backslash_with_yen_sign &&
|
811
825
|
resolve_font_names == other.resolve_font_names &&
|
812
826
|
resource_folder == other.resource_folder &&
|
813
827
|
resource_folder_alias == other.resource_folder_alias &&
|
@@ -825,7 +839,7 @@ module AsposeWordsCloud
|
|
825
839
|
# Calculates hash code according to all attributes.
|
826
840
|
# @return [Fixnum] Hash code
|
827
841
|
def hash
|
828
|
-
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, allow_negative_indent, css_class_name_prefix, css_style_sheet_file_name, css_style_sheet_type, document_split_criteria, document_split_heading_level, encoding, export_document_properties, export_drop_down_form_field_as_text, export_font_resources, export_fonts_as_base64, export_headers_footers_mode, export_images_as_base64, export_language_information, export_list_labels, export_original_url_for_linked_images, export_page_margins, export_page_setup, export_relative_font_size, export_roundtrip_information, export_text_input_form_field_as_text, export_toc_page_numbers, export_xhtml_transitional, font_resources_subsetting_size_threshold, fonts_folder, fonts_folder_alias, html_version, image_resolution, images_folder, images_folder_alias, metafile_format, office_math_output_mode, pretty_format, resolve_font_names, resource_folder, resource_folder_alias, scale_image_to_shape_size, table_width_output_mode, save_format].hash
|
842
|
+
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, allow_negative_indent, css_class_name_prefix, css_style_sheet_file_name, css_style_sheet_type, document_split_criteria, document_split_heading_level, encoding, export_document_properties, export_drop_down_form_field_as_text, export_font_resources, export_fonts_as_base64, export_headers_footers_mode, export_images_as_base64, export_language_information, export_list_labels, export_original_url_for_linked_images, export_page_margins, export_page_setup, export_relative_font_size, export_roundtrip_information, export_text_input_form_field_as_text, export_toc_page_numbers, export_xhtml_transitional, font_resources_subsetting_size_threshold, fonts_folder, fonts_folder_alias, html_version, image_resolution, images_folder, images_folder_alias, metafile_format, office_math_output_mode, pretty_format, replace_backslash_with_yen_sign, resolve_font_names, resource_folder, resource_folder_alias, scale_image_to_shape_size, table_width_output_mode, save_format].hash
|
829
843
|
end
|
830
844
|
|
831
845
|
# Builds the object from hash
|
@@ -192,6 +192,13 @@ module AsposeWordsCloud
|
|
192
192
|
# Gets or sets a value indicating whether to use pretty formats output.
|
193
193
|
attr_accessor :pretty_format
|
194
194
|
|
195
|
+
# Gets or sets the flag that indicates whether backslash characters should be replaced with yen signs.
|
196
|
+
# Default value is false.
|
197
|
+
# By default, Aspose.Words mimics MS Word's behavior and doesn't replace backslash characters with yen signs in
|
198
|
+
# generated HTML documents. However, previous versions of Aspose.Words performed such replacements in certain
|
199
|
+
# scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
|
200
|
+
attr_accessor :replace_backslash_with_yen_sign
|
201
|
+
|
195
202
|
# Gets or sets a value indicating whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats.
|
196
203
|
# The default value is false.
|
197
204
|
attr_accessor :resolve_font_names
|
@@ -285,6 +292,7 @@ module AsposeWordsCloud
|
|
285
292
|
:'metafile_format' => :'MetafileFormat',
|
286
293
|
:'office_math_output_mode' => :'OfficeMathOutputMode',
|
287
294
|
:'pretty_format' => :'PrettyFormat',
|
295
|
+
:'replace_backslash_with_yen_sign' => :'ReplaceBackslashWithYenSign',
|
288
296
|
:'resolve_font_names' => :'ResolveFontNames',
|
289
297
|
:'resource_folder' => :'ResourceFolder',
|
290
298
|
:'resource_folder_alias' => :'ResourceFolderAlias',
|
@@ -343,6 +351,7 @@ module AsposeWordsCloud
|
|
343
351
|
:'metafile_format' => :'String',
|
344
352
|
:'office_math_output_mode' => :'String',
|
345
353
|
:'pretty_format' => :'BOOLEAN',
|
354
|
+
:'replace_backslash_with_yen_sign' => :'BOOLEAN',
|
346
355
|
:'resolve_font_names' => :'BOOLEAN',
|
347
356
|
:'resource_folder' => :'String',
|
348
357
|
:'resource_folder_alias' => :'String',
|
@@ -543,6 +552,10 @@ module AsposeWordsCloud
|
|
543
552
|
self.pretty_format = attributes[:'PrettyFormat']
|
544
553
|
end
|
545
554
|
|
555
|
+
if attributes.key?(:'ReplaceBackslashWithYenSign')
|
556
|
+
self.replace_backslash_with_yen_sign = attributes[:'ReplaceBackslashWithYenSign']
|
557
|
+
end
|
558
|
+
|
546
559
|
if attributes.key?(:'ResolveFontNames')
|
547
560
|
self.resolve_font_names = attributes[:'ResolveFontNames']
|
548
561
|
end
|
@@ -818,6 +831,7 @@ module AsposeWordsCloud
|
|
818
831
|
metafile_format == other.metafile_format &&
|
819
832
|
office_math_output_mode == other.office_math_output_mode &&
|
820
833
|
pretty_format == other.pretty_format &&
|
834
|
+
replace_backslash_with_yen_sign == other.replace_backslash_with_yen_sign &&
|
821
835
|
resolve_font_names == other.resolve_font_names &&
|
822
836
|
resource_folder == other.resource_folder &&
|
823
837
|
resource_folder_alias == other.resource_folder_alias &&
|
@@ -836,7 +850,7 @@ module AsposeWordsCloud
|
|
836
850
|
# Calculates hash code according to all attributes.
|
837
851
|
# @return [Fixnum] Hash code
|
838
852
|
def hash
|
839
|
-
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, allow_negative_indent, css_class_name_prefix, css_style_sheet_file_name, css_style_sheet_type, document_split_criteria, document_split_heading_level, encoding, export_document_properties, export_drop_down_form_field_as_text, export_font_resources, export_fonts_as_base64, export_headers_footers_mode, export_images_as_base64, export_language_information, export_list_labels, export_original_url_for_linked_images, export_page_margins, export_page_setup, export_relative_font_size, export_roundtrip_information, export_text_input_form_field_as_text, export_toc_page_numbers, export_xhtml_transitional, font_resources_subsetting_size_threshold, fonts_folder, fonts_folder_alias, html_version, image_resolution, images_folder, images_folder_alias, metafile_format, office_math_output_mode, pretty_format, resolve_font_names, resource_folder, resource_folder_alias, scale_image_to_shape_size, table_width_output_mode, export_cid_urls_for_mhtml_resources, save_format].hash
|
853
|
+
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, allow_negative_indent, css_class_name_prefix, css_style_sheet_file_name, css_style_sheet_type, document_split_criteria, document_split_heading_level, encoding, export_document_properties, export_drop_down_form_field_as_text, export_font_resources, export_fonts_as_base64, export_headers_footers_mode, export_images_as_base64, export_language_information, export_list_labels, export_original_url_for_linked_images, export_page_margins, export_page_setup, export_relative_font_size, export_roundtrip_information, export_text_input_form_field_as_text, export_toc_page_numbers, export_xhtml_transitional, font_resources_subsetting_size_threshold, fonts_folder, fonts_folder_alias, html_version, image_resolution, images_folder, images_folder_alias, metafile_format, office_math_output_mode, pretty_format, replace_backslash_with_yen_sign, resolve_font_names, resource_folder, resource_folder_alias, scale_image_to_shape_size, table_width_output_mode, export_cid_urls_for_mhtml_resources, save_format].hash
|
840
854
|
end
|
841
855
|
|
842
856
|
# Builds the object from hash
|
@@ -108,6 +108,9 @@ module AsposeWordsCloud
|
|
108
108
|
# Gets or sets the level in the XPS document outline at which to display Word bookmarks.
|
109
109
|
attr_accessor :bookmarks_outline_level
|
110
110
|
|
111
|
+
# Gets or sets the details for signing the output document.
|
112
|
+
attr_accessor :digital_signature_details
|
113
|
+
|
111
114
|
# Gets or sets the number of heading levels (paragraphs formatted with the Heading styles) to include in the XPS document outline.
|
112
115
|
attr_accessor :headings_outline_levels
|
113
116
|
|
@@ -165,6 +168,7 @@ module AsposeWordsCloud
|
|
165
168
|
:'page_count' => :'PageCount',
|
166
169
|
:'page_index' => :'PageIndex',
|
167
170
|
:'bookmarks_outline_level' => :'BookmarksOutlineLevel',
|
171
|
+
:'digital_signature_details' => :'DigitalSignatureDetails',
|
168
172
|
:'headings_outline_levels' => :'HeadingsOutlineLevels',
|
169
173
|
:'outline_options' => :'OutlineOptions',
|
170
174
|
:'use_book_fold_printing_settings' => :'UseBookFoldPrintingSettings',
|
@@ -195,6 +199,7 @@ module AsposeWordsCloud
|
|
195
199
|
:'page_count' => :'Integer',
|
196
200
|
:'page_index' => :'Integer',
|
197
201
|
:'bookmarks_outline_level' => :'Integer',
|
202
|
+
:'digital_signature_details' => :'DigitalSignatureDetails',
|
198
203
|
:'headings_outline_levels' => :'Integer',
|
199
204
|
:'outline_options' => :'OutlineOptionsData',
|
200
205
|
:'use_book_fold_printing_settings' => :'BOOLEAN',
|
@@ -292,6 +297,10 @@ module AsposeWordsCloud
|
|
292
297
|
self.bookmarks_outline_level = attributes[:'BookmarksOutlineLevel']
|
293
298
|
end
|
294
299
|
|
300
|
+
if attributes.key?(:'DigitalSignatureDetails')
|
301
|
+
self.digital_signature_details = attributes[:'DigitalSignatureDetails']
|
302
|
+
end
|
303
|
+
|
295
304
|
if attributes.key?(:'HeadingsOutlineLevels')
|
296
305
|
self.headings_outline_levels = attributes[:'HeadingsOutlineLevels']
|
297
306
|
end
|
@@ -434,6 +443,7 @@ module AsposeWordsCloud
|
|
434
443
|
page_count == other.page_count &&
|
435
444
|
page_index == other.page_index &&
|
436
445
|
bookmarks_outline_level == other.bookmarks_outline_level &&
|
446
|
+
digital_signature_details == other.digital_signature_details &&
|
437
447
|
headings_outline_levels == other.headings_outline_levels &&
|
438
448
|
outline_options == other.outline_options &&
|
439
449
|
use_book_fold_printing_settings == other.use_book_fold_printing_settings &&
|
@@ -449,7 +459,7 @@ module AsposeWordsCloud
|
|
449
459
|
# Calculates hash code according to all attributes.
|
450
460
|
# @return [Fixnum] Hash code
|
451
461
|
def hash
|
452
|
-
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, bookmarks_outline_level, headings_outline_levels, outline_options, use_book_fold_printing_settings, save_format].hash
|
462
|
+
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, bookmarks_outline_level, digital_signature_details, headings_outline_levels, outline_options, use_book_fold_printing_settings, save_format].hash
|
453
463
|
end
|
454
464
|
|
455
465
|
# Builds the object from hash
|
@@ -573,6 +583,9 @@ module AsposeWordsCloud
|
|
573
583
|
unless self.metafile_rendering_options.nil?
|
574
584
|
self.metafile_rendering_options.validate
|
575
585
|
end
|
586
|
+
unless self.digital_signature_details.nil?
|
587
|
+
self.digital_signature_details.validate
|
588
|
+
end
|
576
589
|
unless self.outline_options.nil?
|
577
590
|
self.outline_options.validate
|
578
591
|
end
|
@@ -200,6 +200,11 @@ module AsposeWordsCloud
|
|
200
200
|
# Gets or sets a value indicating whether to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.
|
201
201
|
attr_accessor :use_core_fonts
|
202
202
|
|
203
|
+
# Gets or sets a value indicating whether to use SDT control Tag or Id property as a name of form field in PDF.
|
204
|
+
# The default value is false.When set to false, SDT control Id property is used as a name of form field in PDF.When set to true, SDT control Tag property is used as a name of form field in PDF.If set to true and Tag is empty, Id property will be used as a form field name.If set to true and Tag values are not unique, duplicate Tag values will be altered to build
|
205
|
+
# unique PDF form field names.
|
206
|
+
attr_accessor :use_sdt_tag_as_form_field_name
|
207
|
+
|
203
208
|
# Gets or sets the option that controls what type of zoom should be applied when a document is opened with a PDF viewer.
|
204
209
|
attr_accessor :zoom_behavior
|
205
210
|
|
@@ -278,6 +283,7 @@ module AsposeWordsCloud
|
|
278
283
|
:'text_compression' => :'TextCompression',
|
279
284
|
:'use_book_fold_printing_settings' => :'UseBookFoldPrintingSettings',
|
280
285
|
:'use_core_fonts' => :'UseCoreFonts',
|
286
|
+
:'use_sdt_tag_as_form_field_name' => :'UseSdtTagAsFormFieldName',
|
281
287
|
:'zoom_behavior' => :'ZoomBehavior',
|
282
288
|
:'zoom_factor' => :'ZoomFactor',
|
283
289
|
:'save_format' => :'SaveFormat'
|
@@ -331,6 +337,7 @@ module AsposeWordsCloud
|
|
331
337
|
:'text_compression' => :'String',
|
332
338
|
:'use_book_fold_printing_settings' => :'BOOLEAN',
|
333
339
|
:'use_core_fonts' => :'BOOLEAN',
|
340
|
+
:'use_sdt_tag_as_form_field_name' => :'BOOLEAN',
|
334
341
|
:'zoom_behavior' => :'String',
|
335
342
|
:'zoom_factor' => :'Integer',
|
336
343
|
:'save_format' => :'String'
|
@@ -523,6 +530,10 @@ module AsposeWordsCloud
|
|
523
530
|
self.use_core_fonts = attributes[:'UseCoreFonts']
|
524
531
|
end
|
525
532
|
|
533
|
+
if attributes.key?(:'UseSdtTagAsFormFieldName')
|
534
|
+
self.use_sdt_tag_as_form_field_name = attributes[:'UseSdtTagAsFormFieldName']
|
535
|
+
end
|
536
|
+
|
526
537
|
if attributes.key?(:'ZoomBehavior')
|
527
538
|
self.zoom_behavior = attributes[:'ZoomBehavior']
|
528
539
|
end
|
@@ -813,6 +824,7 @@ module AsposeWordsCloud
|
|
813
824
|
text_compression == other.text_compression &&
|
814
825
|
use_book_fold_printing_settings == other.use_book_fold_printing_settings &&
|
815
826
|
use_core_fonts == other.use_core_fonts &&
|
827
|
+
use_sdt_tag_as_form_field_name == other.use_sdt_tag_as_form_field_name &&
|
816
828
|
zoom_behavior == other.zoom_behavior &&
|
817
829
|
zoom_factor == other.zoom_factor &&
|
818
830
|
save_format == other.save_format
|
@@ -827,7 +839,7 @@ module AsposeWordsCloud
|
|
827
839
|
# Calculates hash code according to all attributes.
|
828
840
|
# @return [Fixnum] Hash code
|
829
841
|
def hash
|
830
|
-
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, cache_background_graphics, compliance, create_note_hyperlinks, custom_properties_export, digital_signature_details, display_doc_title, downsample_options, embed_attachments, embed_full_fonts, encryption_details, export_document_structure, export_language_to_span_tag, font_embedding_mode, header_footer_bookmarks_export_mode, image_color_space_export_mode, image_compression, interpolate_images, open_hyperlinks_in_new_window, outline_options, page_mode, preblend_images, preserve_form_fields, text_compression, use_book_fold_printing_settings, use_core_fonts, zoom_behavior, zoom_factor, save_format].hash
|
842
|
+
[allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, cache_background_graphics, compliance, create_note_hyperlinks, custom_properties_export, digital_signature_details, display_doc_title, downsample_options, embed_attachments, embed_full_fonts, encryption_details, export_document_structure, export_language_to_span_tag, font_embedding_mode, header_footer_bookmarks_export_mode, image_color_space_export_mode, image_compression, interpolate_images, open_hyperlinks_in_new_window, outline_options, page_mode, preblend_images, preserve_form_fields, text_compression, use_book_fold_printing_settings, use_core_fonts, use_sdt_tag_as_form_field_name, zoom_behavior, zoom_factor, save_format].hash
|
831
843
|
end
|
832
844
|
|
833
845
|
# Builds the object from hash
|
@@ -41,6 +41,9 @@ module AsposeWordsCloud
|
|
41
41
|
# The flag indicating whether to execute Mail Merge operation with regions.
|
42
42
|
attr_accessor :with_regions
|
43
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
|
+
|
44
47
|
# The cleanup options.
|
45
48
|
attr_accessor :cleanup
|
46
49
|
|
@@ -53,14 +56,16 @@ module AsposeWordsCloud
|
|
53
56
|
# @param data File with mailmerge data.
|
54
57
|
# @param options Field options.
|
55
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.
|
56
60
|
# @param cleanup The cleanup options.
|
57
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.
|
58
62
|
|
59
|
-
def initialize(template:, data:, options: nil, with_regions: nil, cleanup: nil, document_file_name: nil)
|
63
|
+
def initialize(template:, data:, options: nil, with_regions: nil, merge_whole_document: nil, cleanup: nil, document_file_name: nil)
|
60
64
|
self.template = template
|
61
65
|
self.data = data
|
62
66
|
self.options = options
|
63
67
|
self.with_regions = with_regions
|
68
|
+
self.merge_whole_document = merge_whole_document
|
64
69
|
self.cleanup = cleanup
|
65
70
|
self.document_file_name = document_file_name
|
66
71
|
end
|
@@ -79,6 +84,7 @@ module AsposeWordsCloud
|
|
79
84
|
# query parameters
|
80
85
|
query_params = {}
|
81
86
|
query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
|
87
|
+
query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
|
82
88
|
query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
|
83
89
|
query_params[downcase_first_letter('DocumentFileName')] = self.document_file_name unless self.document_file_name.nil?
|
84
90
|
|
@@ -153,6 +159,7 @@ module AsposeWordsCloud
|
|
153
159
|
# query parameters
|
154
160
|
query_params = {}
|
155
161
|
query_params[downcase_first_letter('WithRegions')] = self.with_regions unless self.with_regions.nil?
|
162
|
+
query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
|
156
163
|
query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
|
157
164
|
query_params[downcase_first_letter('DocumentFileName')] = self.document_file_name unless self.document_file_name.nil?
|
158
165
|
|
@@ -68,6 +68,9 @@ module AsposeWordsCloud
|
|
68
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
69
|
attr_accessor :use_whole_paragraph_as_region
|
70
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
|
+
|
71
74
|
# The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
|
72
75
|
attr_accessor :dest_file_name
|
73
76
|
|
@@ -86,9 +89,10 @@ module AsposeWordsCloud
|
|
86
89
|
# @param mail_merge_data_file The data file.
|
87
90
|
# @param cleanup The cleanup options.
|
88
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.
|
89
93
|
# @param dest_file_name The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
|
90
94
|
|
91
|
-
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, dest_file_name: nil)
|
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)
|
92
96
|
self.name = name
|
93
97
|
self.data = data
|
94
98
|
self.options = options
|
@@ -102,6 +106,7 @@ module AsposeWordsCloud
|
|
102
106
|
self.mail_merge_data_file = mail_merge_data_file
|
103
107
|
self.cleanup = cleanup
|
104
108
|
self.use_whole_paragraph_as_region = use_whole_paragraph_as_region
|
109
|
+
self.merge_whole_document = merge_whole_document
|
105
110
|
self.dest_file_name = dest_file_name
|
106
111
|
end
|
107
112
|
|
@@ -127,6 +132,7 @@ module AsposeWordsCloud
|
|
127
132
|
query_params[downcase_first_letter('MailMergeDataFile')] = self.mail_merge_data_file unless self.mail_merge_data_file.nil?
|
128
133
|
query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
|
129
134
|
query_params[downcase_first_letter('UseWholeParagraphAsRegion')] = self.use_whole_paragraph_as_region unless self.use_whole_paragraph_as_region.nil?
|
135
|
+
query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
|
130
136
|
query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
|
131
137
|
|
132
138
|
if query_params
|
@@ -198,6 +204,7 @@ module AsposeWordsCloud
|
|
198
204
|
query_params[downcase_first_letter('MailMergeDataFile')] = self.mail_merge_data_file unless self.mail_merge_data_file.nil?
|
199
205
|
query_params[downcase_first_letter('Cleanup')] = self.cleanup unless self.cleanup.nil?
|
200
206
|
query_params[downcase_first_letter('UseWholeParagraphAsRegion')] = self.use_whole_paragraph_as_region unless self.use_whole_paragraph_as_region.nil?
|
207
|
+
query_params[downcase_first_letter('MergeWholeDocument')] = self.merge_whole_document unless self.merge_whole_document.nil?
|
201
208
|
query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
|
202
209
|
|
203
210
|
# header parameters
|
@@ -0,0 +1,179 @@
|
|
1
|
+
# ------------------------------------------------------------------------------------
|
2
|
+
# <copyright company="Aspose" file="get_signatures_online_request.rb">
|
3
|
+
# Copyright (c) 2024 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 get_signatures_online operation.
|
30
|
+
#
|
31
|
+
class GetSignaturesOnlineRequest
|
32
|
+
# The document.
|
33
|
+
attr_accessor :document
|
34
|
+
|
35
|
+
# Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
36
|
+
attr_accessor :load_encoding
|
37
|
+
|
38
|
+
# 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.
|
39
|
+
attr_accessor :password
|
40
|
+
|
41
|
+
# Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
|
42
|
+
attr_accessor :encrypted_password
|
43
|
+
|
44
|
+
# The value indicates whether OpenType support is on.
|
45
|
+
attr_accessor :open_type_support
|
46
|
+
|
47
|
+
#
|
48
|
+
# Initializes a new instance.
|
49
|
+
# @param document The document.
|
50
|
+
# @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
51
|
+
# @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.
|
52
|
+
# @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.
|
53
|
+
# @param open_type_support The value indicates whether OpenType support is on.
|
54
|
+
|
55
|
+
def initialize(document:, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil)
|
56
|
+
self.document = document
|
57
|
+
self.load_encoding = load_encoding
|
58
|
+
self.password = password
|
59
|
+
self.encrypted_password = encrypted_password
|
60
|
+
self.open_type_support = open_type_support
|
61
|
+
end
|
62
|
+
|
63
|
+
# Creating batch part from request
|
64
|
+
def to_batch_part(api_client, requestId, parentRequestId = nil)
|
65
|
+
# verify the required parameter 'document' is set
|
66
|
+
raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_signatures_online' if api_client.config.client_side_validation && self.document.nil?
|
67
|
+
|
68
|
+
# resource path
|
69
|
+
local_var_path = '/words/online/get/signatures'[7..-1]
|
70
|
+
local_var_path = local_var_path.sub('//', '/')
|
71
|
+
|
72
|
+
# query parameters
|
73
|
+
query_params = {}
|
74
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
75
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
76
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
77
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
78
|
+
|
79
|
+
if query_params
|
80
|
+
query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
|
81
|
+
end
|
82
|
+
|
83
|
+
header_params = {}
|
84
|
+
# header parameters
|
85
|
+
# HTTP header 'Content-Type'
|
86
|
+
header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
|
87
|
+
header_params['RequestId'] = requestId
|
88
|
+
|
89
|
+
if parentRequestId != nil
|
90
|
+
header_params['DependsOn'] = parentRequestId
|
91
|
+
end
|
92
|
+
|
93
|
+
# form parameters
|
94
|
+
form_params = []
|
95
|
+
files_content = []
|
96
|
+
if self.document.nil?
|
97
|
+
raise "Parameter Document is required."
|
98
|
+
end
|
99
|
+
unless self.document.nil?
|
100
|
+
form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
|
101
|
+
end
|
102
|
+
|
103
|
+
|
104
|
+
# http body (model)
|
105
|
+
body = api_client.build_request_body_batch(header_params, form_params, files_content)
|
106
|
+
part = ""
|
107
|
+
part.concat("PUT".force_encoding('UTF-8'))
|
108
|
+
part.concat(" ".force_encoding('UTF-8'))
|
109
|
+
part.concat(local_var_path.force_encoding('UTF-8'))
|
110
|
+
part.concat(" \r\n".force_encoding('UTF-8'))
|
111
|
+
|
112
|
+
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')) }
|
113
|
+
part.concat("\r\n".force_encoding('UTF-8'))
|
114
|
+
if body
|
115
|
+
if body.is_a?(Hash)
|
116
|
+
body.each do |key, value|
|
117
|
+
part.concat(value, "\r\n")
|
118
|
+
end
|
119
|
+
else
|
120
|
+
part.concat(body)
|
121
|
+
end
|
122
|
+
end
|
123
|
+
part
|
124
|
+
end
|
125
|
+
|
126
|
+
def create_http_request(api_client)
|
127
|
+
# verify the required parameter 'document' is set
|
128
|
+
raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_signatures_online' if api_client.config.client_side_validation && self.document.nil?
|
129
|
+
|
130
|
+
# resource path
|
131
|
+
local_var_path = '/words/online/get/signatures'[1..-1]
|
132
|
+
local_var_path = local_var_path.sub('//', '/')
|
133
|
+
|
134
|
+
# query parameters
|
135
|
+
query_params = {}
|
136
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
137
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
138
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
139
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
140
|
+
|
141
|
+
# header parameters
|
142
|
+
header_params = {}
|
143
|
+
# HTTP header 'Content-Type'
|
144
|
+
header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
|
145
|
+
|
146
|
+
# form parameters
|
147
|
+
form_params = []
|
148
|
+
files_content = []
|
149
|
+
if self.document.nil?
|
150
|
+
raise "Parameter Document is required."
|
151
|
+
end
|
152
|
+
unless self.document.nil?
|
153
|
+
form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
|
154
|
+
end
|
155
|
+
|
156
|
+
body = api_client.build_request_body(header_params, form_params, files_content)
|
157
|
+
{
|
158
|
+
'method': :PUT,
|
159
|
+
'path': local_var_path,
|
160
|
+
'header_params': header_params,
|
161
|
+
'query_params': query_params,
|
162
|
+
'body': body,
|
163
|
+
'auth_names': ['JWT']
|
164
|
+
}
|
165
|
+
end
|
166
|
+
|
167
|
+
#
|
168
|
+
# Helper method to convert first letter to downcase
|
169
|
+
#
|
170
|
+
def downcase_first_letter(str)
|
171
|
+
str[0].downcase + str[1..-1]
|
172
|
+
end
|
173
|
+
|
174
|
+
# Get response type
|
175
|
+
def get_response_type
|
176
|
+
'SignatureCollectionResponse'
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|