aspose_words_cloud 25.9 → 25.11

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 (71) hide show
  1. checksums.yaml +4 -4
  2. data/lib/aspose_words_cloud/api/words_api.rb +52 -6
  3. data/lib/aspose_words_cloud/models/azw3_save_options_data.rb +4 -4
  4. data/lib/aspose_words_cloud/models/bmp_save_options_data.rb +1 -1
  5. data/lib/aspose_words_cloud/models/comment.rb +2 -2
  6. data/lib/aspose_words_cloud/models/comment_insert.rb +2 -2
  7. data/lib/aspose_words_cloud/models/comment_update.rb +2 -2
  8. data/lib/aspose_words_cloud/models/compress_options.rb +2 -2
  9. data/lib/aspose_words_cloud/models/custom_xml_part.rb +1 -1
  10. data/lib/aspose_words_cloud/models/custom_xml_part_insert.rb +1 -1
  11. data/lib/aspose_words_cloud/models/custom_xml_part_update.rb +1 -1
  12. data/lib/aspose_words_cloud/models/doc_save_options_data.rb +1 -1
  13. data/lib/aspose_words_cloud/models/docm_save_options_data.rb +1 -1
  14. data/lib/aspose_words_cloud/models/docx_save_options_data.rb +1 -1
  15. data/lib/aspose_words_cloud/models/dot_save_options_data.rb +1 -1
  16. data/lib/aspose_words_cloud/models/dotm_save_options_data.rb +1 -1
  17. data/lib/aspose_words_cloud/models/dotx_save_options_data.rb +1 -1
  18. data/lib/aspose_words_cloud/models/emf_save_options_data.rb +1 -1
  19. data/lib/aspose_words_cloud/models/eps_save_options_data.rb +1 -1
  20. data/lib/aspose_words_cloud/models/epub_save_options_data.rb +4 -4
  21. data/lib/aspose_words_cloud/models/field_options.rb +1 -1
  22. data/lib/aspose_words_cloud/models/flat_opc_macro_save_options_data.rb +1 -1
  23. data/lib/aspose_words_cloud/models/flat_opc_save_options_data.rb +1 -1
  24. data/lib/aspose_words_cloud/models/flat_opc_template_macro_save_options_data.rb +1 -1
  25. data/lib/aspose_words_cloud/models/flat_opc_template_save_options_data.rb +1 -1
  26. data/lib/aspose_words_cloud/models/footnote.rb +1 -1
  27. data/lib/aspose_words_cloud/models/footnote_insert.rb +1 -1
  28. data/lib/aspose_words_cloud/models/footnote_update.rb +1 -1
  29. data/lib/aspose_words_cloud/models/form_field_checkbox.rb +1 -1
  30. data/lib/aspose_words_cloud/models/form_field_drop_down.rb +1 -1
  31. data/lib/aspose_words_cloud/models/form_field_text_input.rb +1 -1
  32. data/lib/aspose_words_cloud/models/gif_save_options_data.rb +1 -1
  33. data/lib/aspose_words_cloud/models/html_fixed_save_options_data.rb +4 -4
  34. data/lib/aspose_words_cloud/models/html_save_options_data.rb +4 -4
  35. data/lib/aspose_words_cloud/models/jpeg_save_options_data.rb +1 -1
  36. data/lib/aspose_words_cloud/models/list_level.rb +1 -1
  37. data/lib/aspose_words_cloud/models/list_level_update.rb +1 -1
  38. data/lib/aspose_words_cloud/models/markdown_save_options_data.rb +2 -2
  39. data/lib/aspose_words_cloud/models/mhtml_save_options_data.rb +4 -4
  40. data/lib/aspose_words_cloud/models/odt_save_options_data.rb +1 -1
  41. data/lib/aspose_words_cloud/models/open_xps_save_options_data.rb +1 -1
  42. data/lib/aspose_words_cloud/models/ott_save_options_data.rb +1 -1
  43. data/lib/aspose_words_cloud/models/pcl_save_options_data.rb +1 -1
  44. data/lib/aspose_words_cloud/models/pdf_save_options_data.rb +19 -6
  45. data/lib/aspose_words_cloud/models/png_save_options_data.rb +1 -1
  46. data/lib/aspose_words_cloud/models/ps_save_options_data.rb +1 -1
  47. data/lib/aspose_words_cloud/models/requests/build_report_online_request.rb +4 -4
  48. data/lib/aspose_words_cloud/models/requests/build_report_request.rb +4 -4
  49. data/lib/aspose_words_cloud/models/requests/load_web_document_online_request.rb +151 -0
  50. data/lib/aspose_words_cloud/models/requests/sign_document_online_request.rb +2 -2
  51. data/lib/aspose_words_cloud/models/requests/sign_document_request.rb +2 -2
  52. data/lib/aspose_words_cloud/models/responses/load_web_document_online_response.rb +46 -0
  53. data/lib/aspose_words_cloud/models/rtf_save_options_data.rb +1 -1
  54. data/lib/aspose_words_cloud/models/sign_options.rb +6 -6
  55. data/lib/aspose_words_cloud/models/signature.rb +1 -1
  56. data/lib/aspose_words_cloud/models/structured_document_tag.rb +21 -21
  57. data/lib/aspose_words_cloud/models/structured_document_tag_insert.rb +21 -21
  58. data/lib/aspose_words_cloud/models/structured_document_tag_update.rb +21 -21
  59. data/lib/aspose_words_cloud/models/style.rb +1 -1
  60. data/lib/aspose_words_cloud/models/style_update.rb +1 -1
  61. data/lib/aspose_words_cloud/models/svg_save_options_data.rb +2 -2
  62. data/lib/aspose_words_cloud/models/text_save_options_data.rb +30 -3
  63. data/lib/aspose_words_cloud/models/tiff_save_options_data.rb +2 -2
  64. data/lib/aspose_words_cloud/models/word_ml_save_options_data.rb +1 -1
  65. data/lib/aspose_words_cloud/models/xaml_fixed_save_options_data.rb +1 -1
  66. data/lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb +2 -2
  67. data/lib/aspose_words_cloud/models/xaml_flow_save_options_data.rb +2 -2
  68. data/lib/aspose_words_cloud/models/xps_save_options_data.rb +1 -1
  69. data/lib/aspose_words_cloud/version.rb +1 -1
  70. data/lib/aspose_words_cloud.rb +1 -0
  71. metadata +4 -2
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -139,7 +139,7 @@ module AsposeWordsCloud
139
139
 
140
140
  # Gets or sets a value indicating whether page margins are exported to HTML, MHTML or EPUB.
141
141
  # The default value is false.
142
- # Aspose.Words does not show area of page margins by default. If any elements are completely or partially clipped by the document edge the displayed area can be extended with this option.
142
+ # Aspose.Words does not show the area of page margins by default. If any elements are completely or partially clipped by the document edge the displayed area can be extended with this option.
143
143
  attr_accessor :export_page_margins
144
144
 
145
145
  # Gets or sets a value indicating whether page setup is exported.
@@ -171,7 +171,7 @@ module AsposeWordsCloud
171
171
  attr_accessor :fonts_folder_alias
172
172
 
173
173
  # Gets or sets the version of HTML standard, that should be used when saving the document to HTML or MHTML.
174
- # Default value is Aspose.Words.Saving.HtmlVersion.Xhtml.
174
+ # The default value is Aspose.Words.Saving.HtmlVersion.Xhtml.
175
175
  attr_accessor :html_version
176
176
 
177
177
  # Gets or sets the output resolution for images when exporting.
@@ -202,7 +202,7 @@ module AsposeWordsCloud
202
202
  attr_accessor :remove_java_script_from_links
203
203
 
204
204
  # Gets or sets the flag that indicates whether backslash characters should be replaced with yen signs.
205
- # Default value is false.
205
+ # The default value is false.
206
206
  # By default, Aspose.Words mimics MS Word's behavior and doesn't replace backslash characters with yen signs in
207
207
  # generated HTML documents. However, previous versions of Aspose.Words performed such replacements in certain
208
208
  # scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -109,13 +109,13 @@ module AsposeWordsCloud
109
109
  attr_accessor :page_index
110
110
 
111
111
  # Gets or sets a value determining how attachments are embedded to the PDF document.
112
- # Default value is None and attachments are not embedded.
112
+ # The default value is None and attachments are not embedded.
113
113
  # PDF/A-1, PDF/A-2 and regular PDF/A-4 (not PDF/A-4f) standards do not allow embedded files.
114
114
  # None value will be used automatically.
115
115
  attr_accessor :attachments_embedding_mode
116
116
 
117
117
  # Gets or sets a value determining whether or not to cache graphics placed in document's background.
118
- # Default value is true and background graphics are written to the PDF document as an xObject. When the value is false background graphics are not cached. Some shapes are not supported for caching(shapes with fields, bookmarks, HRefs). Document background graphic is various shapes, charts, images placed in the footer or header,
118
+ # The default value is true and background graphics are written to the PDF document as an xObject. When the value is false background graphics are not cached. Some shapes are not supported for caching(shapes with fields, bookmarks, HRefs). Document background graphic is various shapes, charts, images placed in the footer or header,
119
119
  # well as background and border of a page.
120
120
  attr_accessor :cache_background_graphics
121
121
 
@@ -143,7 +143,7 @@ module AsposeWordsCloud
143
143
  attr_accessor :downsample_options
144
144
 
145
145
  # Gets or sets a value determining whether or not to embed attachments to the PDF document.
146
- # Default value is false and attachments are not embedded.
146
+ # The default value is false and attachments are not embedded.
147
147
  # When the value is true attachments are embedded to the PDF document.
148
148
  # Embedding attachments is not supported when saving to PDF/A and PDF/UA compliance.
149
149
  # false value will be used automatically.
@@ -160,7 +160,7 @@ module AsposeWordsCloud
160
160
  attr_accessor :export_document_structure
161
161
 
162
162
  # Gets or sets a value determining whether or not to create a "Span" tag in the document structure to export the text language.
163
- # Default value is false and "Lang" attribute is attached to a marked-content sequence in a page content stream.
163
+ # The default value is false and "Lang" attribute is attached to a marked-content sequence in a page content stream.
164
164
  # When the value is true "Span" tag is created for the text with non-default language and "Lang" attribute is attached to this tag.
165
165
  # This value is ignored when Aspose.Words.Saving.PdfSaveOptions.ExportDocumentStructure is false.
166
166
  attr_accessor :export_language_to_span_tag
@@ -225,6 +225,12 @@ module AsposeWordsCloud
225
225
  # Gets or sets the zoom factor (in percentages) for a document.
226
226
  attr_accessor :zoom_factor
227
227
 
228
+ # Gets or sets a value determining whether floating shapes are exported as inline tags in the document structure.
229
+ # The default value is false and floating shapes will be exported as block-level tags,
230
+ # placed after the paragraph in which they are anchored. When the value is true floating shapes will be exported as inline tags,
231
+ # placed within the paragraph where they are anchored. This value is ignored when ExportDocumentStructure is false.
232
+ attr_accessor :export_floating_shapes_as_inline_tag
233
+
228
234
  # Gets the format of save.
229
235
  attr_accessor :save_format
230
236
 
@@ -303,6 +309,7 @@ module AsposeWordsCloud
303
309
  :'use_sdt_tag_as_form_field_name' => :'UseSdtTagAsFormFieldName',
304
310
  :'zoom_behavior' => :'ZoomBehavior',
305
311
  :'zoom_factor' => :'ZoomFactor',
312
+ :'export_floating_shapes_as_inline_tag' => :'ExportFloatingShapesAsInlineTag',
306
313
  :'save_format' => :'SaveFormat'
307
314
  }
308
315
  end
@@ -360,6 +367,7 @@ module AsposeWordsCloud
360
367
  :'use_sdt_tag_as_form_field_name' => :'BOOLEAN',
361
368
  :'zoom_behavior' => :'String',
362
369
  :'zoom_factor' => :'Integer',
370
+ :'export_floating_shapes_as_inline_tag' => :'BOOLEAN',
363
371
  :'save_format' => :'String'
364
372
  }
365
373
  end
@@ -573,6 +581,10 @@ module AsposeWordsCloud
573
581
  if attributes.key?(:'ZoomFactor')
574
582
  self.zoom_factor = attributes[:'ZoomFactor']
575
583
  end
584
+
585
+ if attributes.key?(:'ExportFloatingShapesAsInlineTag')
586
+ self.export_floating_shapes_as_inline_tag = attributes[:'ExportFloatingShapesAsInlineTag']
587
+ end
576
588
  end
577
589
 
578
590
  # Check to see if the all the properties in the model are valid
@@ -878,6 +890,7 @@ module AsposeWordsCloud
878
890
  use_sdt_tag_as_form_field_name == other.use_sdt_tag_as_form_field_name &&
879
891
  zoom_behavior == other.zoom_behavior &&
880
892
  zoom_factor == other.zoom_factor &&
893
+ export_floating_shapes_as_inline_tag == other.export_floating_shapes_as_inline_tag &&
881
894
  save_format == other.save_format
882
895
  end
883
896
 
@@ -890,7 +903,7 @@ module AsposeWordsCloud
890
903
  # Calculates hash code according to all attributes.
891
904
  # @return [Fixnum] Hash code
892
905
  def hash
893
- [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_ambiguous_text_font, 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, attachments_embedding_mode, 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, render_choice_form_field_border, text_compression, use_book_fold_printing_settings, use_core_fonts, use_sdt_tag_as_form_field_name, zoom_behavior, zoom_factor, save_format].hash
906
+ [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_ambiguous_text_font, 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, attachments_embedding_mode, 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, render_choice_form_field_border, text_compression, use_book_fold_printing_settings, use_core_fonts, use_sdt_tag_as_form_field_name, zoom_behavior, zoom_factor, export_floating_shapes_as_inline_tag, save_format].hash
894
907
  end
895
908
 
896
909
  # Builds the object from hash
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -32,10 +32,10 @@ module AsposeWordsCloud
32
32
  # File with template.
33
33
  attr_accessor :template
34
34
 
35
- # A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
35
+ # A string providing data to populate the specified template. The string must be of one of the following types: xml, json, csv.
36
36
  attr_accessor :data
37
37
 
38
- # An object providing a settings of report engine.
38
+ # An object providing settings of a report engine.
39
39
  attr_accessor :report_engine_settings
40
40
 
41
41
  # 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.
@@ -44,8 +44,8 @@ module AsposeWordsCloud
44
44
  #
45
45
  # Initializes a new instance.
46
46
  # @param template File with template.
47
- # @param data A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
48
- # @param report_engine_settings An object providing a settings of report engine.
47
+ # @param data A string providing data to populate the specified template. The string must be of one of the following types: xml, json, csv.
48
+ # @param report_engine_settings An object providing settings of a report engine.
49
49
  # @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.
50
50
 
51
51
  def initialize(template:, data:, report_engine_settings:, document_file_name: nil)
@@ -32,10 +32,10 @@ module AsposeWordsCloud
32
32
  # The filename of the input document.
33
33
  attr_accessor :name
34
34
 
35
- # A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
35
+ # A string providing data to populate the specified template. The string must be of one of the following types: xml, json, csv.
36
36
  attr_accessor :data
37
37
 
38
- # An object providing a settings of report engine.
38
+ # An object providing settings of a report engine.
39
39
  attr_accessor :report_engine_settings
40
40
 
41
41
  # Original document folder.
@@ -62,8 +62,8 @@ module AsposeWordsCloud
62
62
  #
63
63
  # Initializes a new instance.
64
64
  # @param name The filename of the input document.
65
- # @param data A string providing a data to populate the specified template. The string must be of one of the following types: xml, json, csv.
66
- # @param report_engine_settings An object providing a settings of report engine.
65
+ # @param data A string providing data to populate the specified template. The string must be of one of the following types: xml, json, csv.
66
+ # @param report_engine_settings An object providing settings of a report engine.
67
67
  # @param folder Original document folder.
68
68
  # @param storage Original document storage.
69
69
  # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
@@ -0,0 +1,151 @@
1
+ # ------------------------------------------------------------------------------------
2
+ # <copyright company="Aspose" file="load_web_document_online_request.rb">
3
+ # Copyright (c) 2025 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 load_web_document_online operation.
30
+ #
31
+ class LoadWebDocumentOnlineRequest
32
+ # The properties of data downloading.
33
+ attr_accessor :data
34
+
35
+ #
36
+ # Initializes a new instance.
37
+ # @param data The properties of data downloading.
38
+
39
+ def initialize(data:)
40
+ self.data = data
41
+ end
42
+
43
+ # Creating batch part from request
44
+ def to_batch_part(api_client, requestId, parentRequestId = nil)
45
+ # verify the required parameter 'data' is set
46
+ raise ArgumentError, 'Missing the required parameter data when calling WordsApi.load_web_document_online' if api_client.config.client_side_validation && self.data.nil?
47
+ self.data.validate
48
+ # resource path
49
+ local_var_path = '/words/online/put/loadWebDocument'[7..-1]
50
+ local_var_path = local_var_path.sub('//', '/')
51
+
52
+ # query parameters
53
+ query_params = {}
54
+
55
+ if query_params
56
+ query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
57
+ end
58
+
59
+ header_params = {}
60
+ # header parameters
61
+ # HTTP header 'Content-Type'
62
+ header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
63
+ header_params['RequestId'] = requestId
64
+
65
+ if parentRequestId != nil
66
+ header_params['DependsOn'] = parentRequestId
67
+ end
68
+
69
+ # form parameters
70
+ form_params = []
71
+ files_content = []
72
+ if self.data.nil?
73
+ raise "Parameter Data is required."
74
+ end
75
+ unless self.data.nil?
76
+ form_params.push({:'Name' => 'data', :'Data' => self.data.to_body.to_json, :'MimeType' =>'application/json'})
77
+ end
78
+
79
+
80
+ # http body (model)
81
+ body = api_client.build_request_body_batch(header_params, form_params, files_content)
82
+ part = ""
83
+ part.concat("PUT".force_encoding('UTF-8'))
84
+ part.concat(" ".force_encoding('UTF-8'))
85
+ part.concat(local_var_path.force_encoding('UTF-8'))
86
+ part.concat(" \r\n".force_encoding('UTF-8'))
87
+
88
+ 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')) }
89
+ part.concat("\r\n".force_encoding('UTF-8'))
90
+ if body
91
+ if body.is_a?(Hash)
92
+ body.each do |key, value|
93
+ part.concat(value, "\r\n")
94
+ end
95
+ else
96
+ part.concat(body)
97
+ end
98
+ end
99
+ part
100
+ end
101
+
102
+ def create_http_request(api_client)
103
+ # verify the required parameter 'data' is set
104
+ raise ArgumentError, 'Missing the required parameter data when calling WordsApi.load_web_document_online' if api_client.config.client_side_validation && self.data.nil?
105
+ self.data.validate
106
+ # resource path
107
+ local_var_path = '/words/online/put/loadWebDocument'[1..-1]
108
+ local_var_path = local_var_path.sub('//', '/')
109
+
110
+ # query parameters
111
+ query_params = {}
112
+
113
+ # header parameters
114
+ header_params = {}
115
+ # HTTP header 'Content-Type'
116
+ header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
117
+
118
+ # form parameters
119
+ form_params = []
120
+ files_content = []
121
+ if self.data.nil?
122
+ raise "Parameter Data is required."
123
+ end
124
+ unless self.data.nil?
125
+ form_params.push({:'Name' => 'data', :'Data' => self.data.to_body.to_json, :'MimeType' =>'application/json'})
126
+ end
127
+
128
+ body = api_client.build_request_body(header_params, form_params, files_content)
129
+ {
130
+ 'method': :PUT,
131
+ 'path': local_var_path,
132
+ 'header_params': header_params,
133
+ 'query_params': query_params,
134
+ 'body': body,
135
+ 'auth_names': ['JWT']
136
+ }
137
+ end
138
+
139
+ #
140
+ # Helper method to convert first letter to downcase
141
+ #
142
+ def downcase_first_letter(str)
143
+ str[0].downcase + str[1..-1]
144
+ end
145
+
146
+ # Get response type
147
+ def get_response_type
148
+ 'LoadWebDocumentOnlineResponse'
149
+ end
150
+ end
151
+ end
@@ -32,7 +32,7 @@ module AsposeWordsCloud
32
32
  # The document.
33
33
  attr_accessor :document
34
34
 
35
- # certifate file path.
35
+ # certificate file path.
36
36
  attr_accessor :certificate_path
37
37
 
38
38
  # certificate password.
@@ -56,7 +56,7 @@ module AsposeWordsCloud
56
56
  #
57
57
  # Initializes a new instance.
58
58
  # @param document The document.
59
- # @param certificate_path certifate file path.
59
+ # @param certificate_path certificate file path.
60
60
  # @param certificate_password certificate password.
61
61
  # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
62
62
  # @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.
@@ -32,7 +32,7 @@ module AsposeWordsCloud
32
32
  # Name of the document to sign.
33
33
  attr_accessor :name
34
34
 
35
- # certifate file path.
35
+ # certificate file path.
36
36
  attr_accessor :certificate_path
37
37
 
38
38
  # certificate password.
@@ -62,7 +62,7 @@ module AsposeWordsCloud
62
62
  #
63
63
  # Initializes a new instance.
64
64
  # @param name Name of the document to sign.
65
- # @param certificate_path certifate file path.
65
+ # @param certificate_path certificate file path.
66
66
  # @param certificate_password certificate password.
67
67
  # @param folder Original document folder.
68
68
  # @param storage Original document storage.
@@ -0,0 +1,46 @@
1
+ # ------------------------------------------------------------------------------------
2
+ # <copyright company="Aspose" file="load_web_document_online_response.rb">
3
+ # Copyright (c) 2025 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
+ # Response model for load_web_document_online operation.
30
+ #
31
+ class LoadWebDocumentOnlineResponse
32
+ # The REST response with a save result.
33
+ attr_accessor :model
34
+
35
+ # The document after modification.
36
+ attr_accessor :document
37
+
38
+ #
39
+ # Initializes a new instance.
40
+ #
41
+ def initialize()
42
+ self.model = nil
43
+ self.document = nil
44
+ end
45
+ end
46
+ end
@@ -64,7 +64,7 @@ module AsposeWordsCloud
64
64
  attr_accessor :update_ambiguous_text_font
65
65
 
66
66
  # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
67
- # Default value is false.
67
+ # The default value is false.
68
68
  attr_accessor :update_created_time_property
69
69
 
70
70
  # Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
@@ -29,22 +29,22 @@ module AsposeWordsCloud
29
29
 
30
30
  # Container class for digital signature options.
31
31
  class SignOptions
32
- # Gets or sets comments on the digital signature. Default value is empty string.
32
+ # Gets or sets comments on the digital signature. The default value is an empty string.
33
33
  attr_accessor :comments
34
34
 
35
- # Gets or sets the password to decrypt source document. Default value is empty string.
35
+ # Gets or sets the password to decrypt source document. The default value is an empty string.
36
36
  attr_accessor :decryption_password
37
37
 
38
- # Gets or sets the class Guid of the signature cryptography provider. Default value is Empty (all zeroes) Guid.
38
+ # Gets or sets the class Guid of the signature cryptography provider. The default value is Empty (all zeroes) Guid.
39
39
  attr_accessor :provider_id
40
40
 
41
- # Gets or sets user defined signature line Guid. Default value is Empty (all zeroes) Guid.
41
+ # Gets or sets user defined signature line Guid. The default value is Empty (all zeroes) Guid.
42
42
  attr_accessor :signature_line_id
43
43
 
44
- # Gets or sets the image that will be shown in associated SignatureLine. Default value is empty string.
44
+ # Gets or sets the image that will be shown in associated SignatureLine. The default value is an empty string.
45
45
  attr_accessor :signature_line_image_filename
46
46
 
47
- # Gets or sets the date of signing. Default value is current time (Now).
47
+ # Gets or sets the date of signing. The default value is current time (Now).
48
48
  attr_accessor :sign_time
49
49
  # Attribute mapping from ruby-style variable name to JSON key.
50
50
  def self.attribute_map
@@ -33,7 +33,7 @@ module AsposeWordsCloud
33
33
  # Gets or sets the signing purpose comment.
34
34
  attr_accessor :comments
35
35
 
36
- # Gets or sets the subject distinguished name of the certificate isuuer.
36
+ # Gets or sets the subject distinguished name of the certificate issuer.
37
37
  attr_accessor :issuer_name
38
38
 
39
39
  # Gets or sets a value indicating whether this digital signature is valid.
@@ -36,56 +36,56 @@ module AsposeWordsCloud
36
36
  attr_accessor :node_id
37
37
 
38
38
  # Gets or sets Aspose.Words.Markup.SdtListItemCollection associated with this SDT.
39
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.ComboBox or Aspose.Words.Markup.SdtType.DropDownList SDT types.
40
- # For all other SDT types exception will occur.
39
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.ComboBox or Aspose.Words.Markup.SdtType.DropDownList SDT types.
40
+ # For all other SDT types, an exception will occur.
41
41
  attr_accessor :list_items
42
42
 
43
43
  # Gets or sets a value indicating whether current state of the Checkbox SDT. Default value for this property.
44
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.Checkbox SDT types.
45
- # For all other SDT types exception will occur.
44
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.Checkbox SDT types.
45
+ # For all other SDT types, an exception will occur.
46
46
  attr_accessor :checked
47
47
 
48
48
  # Gets or sets the appearance of a structured document tag.
49
49
  attr_accessor :appearance
50
50
 
51
51
  # Gets or sets the language format for the date displayed in this SDT.
52
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.Date SDT type.
53
- # For all other SDT types exception will occur.
52
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.Date SDT type.
53
+ # For all other SDT types, an exception will occur.
54
54
  attr_accessor :date_display_locale
55
55
 
56
56
  # Gets or sets String that represents the format in which dates are displayed. Can not be null. The dates for English (U.S.) is "mm/dd/yyyy".
57
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.Date SDT type.
58
- # For all other SDT types exception will occur.
57
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.Date SDT type.
58
+ # For all other SDT types, an exception will occur.
59
59
  attr_accessor :date_display_format
60
60
 
61
61
  # Gets or sets the full date and time last entered into this SDT.
62
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.Date SDT type.
63
- # For all other SDT types exception will occur.
62
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.Date SDT type.
63
+ # For all other SDT types, an exception will occur.
64
64
  attr_accessor :full_date
65
65
 
66
66
  # Gets or sets the friendly name associated with this SDT. Can not be null.
67
67
  attr_accessor :title
68
68
 
69
69
  # Gets or sets format in which the date for a date SDT is stored when the SDT is bound to an XML node in the document's data store.
70
- # Default value is Aspose.Words.Markup.SdtDateStorageFormat.DateTime.
71
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.Date SDT type.
72
- # For all other SDT types exception will occur.
70
+ # The default value is Aspose.Words.Markup.SdtDateStorageFormat.DateTime.
71
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.Date SDT type.
72
+ # For all other SDT types, an exception will occur.
73
73
  attr_accessor :date_storage_format
74
74
 
75
75
  # Gets or sets type of building block for this SDT. Can not be null.
76
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.BuildingBlockGallery and Aspose.Words.Markup.SdtType.DocPartObj SDT types.
76
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.BuildingBlockGallery and Aspose.Words.Markup.SdtType.DocPartObj SDT types.
77
77
  # It is read-only for SDT of the document part type.
78
- # For all other SDT types exception will occur.
78
+ # For all other SDT types, an exception will occur.
79
79
  attr_accessor :building_block_gallery
80
80
 
81
81
  # Gets or sets category of building block for this SDT node. Can not be null.
82
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.BuildingBlockGallery and Aspose.Words.Markup.SdtType.DocPartObj SDT types.
83
- # It is read-only for SDT of the document part type. For all other SDT types exception will occur.
82
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.BuildingBlockGallery and Aspose.Words.Markup.SdtType.DocPartObj SDT types.
83
+ # It is read-only for SDT of the document part type. For all other SDT types, an exception will occur.
84
84
  attr_accessor :building_block_category
85
85
 
86
86
  # Gets or sets a value indicating whether this SDT allows multiple lines of text.
87
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.RichText and Aspose.Words.Markup.SdtType.PlainText SDT type.
88
- # For all other SDT types exception will occur.
87
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.RichText and Aspose.Words.Markup.SdtType.PlainText SDT type.
88
+ # For all other SDT types, an exception will occur.
89
89
  attr_accessor :multiline
90
90
 
91
91
  # Gets or sets the color of the structured document tag.
@@ -95,8 +95,8 @@ module AsposeWordsCloud
95
95
  attr_accessor :style_name
96
96
 
97
97
  # Gets or sets the type of calendar for this SDT. Default is Aspose.Words.Markup.SdtCalendarType.Default.
98
- # Accessing this property will only work for Aspose.Words.Markup.SdtType.Date SDT type.
99
- # For all other SDT types exception will occur.
98
+ # Accessing this property will work only for Aspose.Words.Markup.SdtType.Date SDT type.
99
+ # For all other SDT types, an exception will occur.
100
100
  attr_accessor :calendar_type
101
101
 
102
102
  # Gets or sets a value indicating whether this SDT shall be removed from the WordProcessingML document when its contents are modified.