aspose_words_cloud 21.5.0 → 21.8.0

data/lib/aspose_words_cloud/models/requests/get_custom_xml_parts_request.rb

@@ -0,0 +1,161 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose" file="get_custom_xml_parts_request.rb">
+#   Copyright (c) 2021 Aspose.Words for Cloud
+# </copyright>
+# <summary>
+#  Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+# </summary>
+# ------------------------------------------------------------------------------------
+
+module AsposeWordsCloud
+
+  #
+  # Request model for get_custom_xml_parts operation.
+  #
+  class GetCustomXmlPartsRequest
+    # The filename of the input document.
+    attr_accessor :name
+
+    # Original document folder.
+    attr_accessor :folder
+
+    # Original document storage.
+    attr_accessor :storage
+
+    # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+    attr_accessor :load_encoding
+
+    # Password for opening an encrypted document.
+    attr_accessor :password
+
+    #
+    # Initializes a new instance.
+    # @param name The filename of the input document.
+    # @param folder Original document folder.
+    # @param storage Original document storage.
+    # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+    # @param password Password for opening an encrypted document.
+
+    def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil)
+      self.name = name
+      self.folder = folder
+      self.storage = storage
+      self.load_encoding = load_encoding
+      self.password = password
+    end
+
+    # Creating batch part from request
+    def to_batch_part(api_client)
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_custom_xml_parts' if api_client.config.client_side_validation && self.name.nil?
+
+      # resource path
+      local_var_path = '/words/{name}/customXmlParts'[7..-1]
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
+      local_var_path = local_var_path.sub('//', '/')
+
+      # query parameters
+      query_params = {}
+      query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
+      query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
+      query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
+      query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
+
+      if query_params
+        query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
+      end
+
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      body = nil
+      part = ""
+      part.concat("GET".force_encoding('UTF-8'))
+      part.concat(" ".force_encoding('UTF-8'))
+      part.concat(local_var_path.force_encoding('UTF-8'))
+      part.concat(" \r\n".force_encoding('UTF-8'))
+
+      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')) }
+      part.concat("\r\n".force_encoding('UTF-8'))
+      if body
+        if body.is_a?(Hash)
+          body.each do |key, value|
+          part.concat(value, "\r\n")
+        end
+        else
+          part.concat(body)
+        end
+      end
+     part
+    end
+
+    def create_http_request(api_client)
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_custom_xml_parts' if api_client.config.client_side_validation && self.name.nil?
+
+      # resource path
+      local_var_path = '/words/{name}/customXmlParts'[1..-1]
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
+      local_var_path = local_var_path.sub('//', '/')
+
+      # query parameters
+      query_params = {}
+      query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
+      query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
+      query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
+      query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      body = api_client.build_request_body(header_params, form_params, post_body)
+      {
+        'method': :GET,
+        'path': local_var_path,
+        'header_params': header_params,
+        'query_params': query_params,
+        'body': body,
+        'auth_names': ['JWT']
+      }
+    end
+
+    #
+    # Helper method to convert first letter to downcase
+    #
+    def downcase_first_letter(str)
+      str[0].downcase + str[1..-1]
+    end
+
+    # Get response type
+    def get_response_type
+      'CustomXmlPartsResponse'
+    end
+  end
+end

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_by_index_online_request.rb

@@ -52,7 +52,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, index, node_path = nil, load_encoding = nil, password = nil)
+    def initialize(document:, index:, node_path: nil, load_encoding: nil, password: nil)
       self.document = document
       self.index = index
       self.node_path = node_path

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_by_index_request.rb

@@ -60,7 +60,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, index, node_path = nil, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, index:, node_path: nil, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.index = index
       self.node_path = node_path

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_image_data_online_request.rb

@@ -52,7 +52,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, index, node_path = nil, load_encoding = nil, password = nil)
+    def initialize(document:, index:, node_path: nil, load_encoding: nil, password: nil)
       self.document = document
       self.index = index
       self.node_path = node_path

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_image_data_request.rb

@@ -60,7 +60,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, index, node_path = nil, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, index:, node_path: nil, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.index = index
       self.node_path = node_path

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_ole_data_online_request.rb

@@ -52,7 +52,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, index, node_path = nil, load_encoding = nil, password = nil)
+    def initialize(document:, index:, node_path: nil, load_encoding: nil, password: nil)
       self.document = document
       self.index = index
       self.node_path = node_path

data/lib/aspose_words_cloud/models/requests/get_document_drawing_object_ole_data_request.rb

@@ -60,7 +60,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, index, node_path = nil, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, index:, node_path: nil, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.index = index
       self.node_path = node_path

data/lib/aspose_words_cloud/models/requests/get_document_drawing_objects_online_request.rb

@@ -48,7 +48,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, node_path = nil, load_encoding = nil, password = nil)
+    def initialize(document:, node_path: nil, load_encoding: nil, password: nil)
       self.document = document
       self.node_path = node_path
       self.load_encoding = load_encoding

data/lib/aspose_words_cloud/models/requests/get_document_drawing_objects_request.rb

@@ -56,7 +56,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, node_path = nil, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, node_path: nil, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.node_path = node_path
       self.folder = folder

data/lib/aspose_words_cloud/models/requests/get_document_field_names_online_request.rb

@@ -29,8 +29,8 @@ module AsposeWordsCloud
   # Request model for get_document_field_names_online operation.
   #
   class GetDocumentFieldNamesOnlineRequest
-    # The document.
-    attr_accessor :document
+    # The template document.
+    attr_accessor :template
 
     # Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     attr_accessor :load_encoding
@@ -43,13 +43,13 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param document The document.
+    # @param template The template document.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
     # @param use_non_merge_fields The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
 
-    def initialize(document, load_encoding = nil, password = nil, use_non_merge_fields = nil)
-      self.document = document
+    def initialize(template:, load_encoding: nil, password: nil, use_non_merge_fields: nil)
+      self.template = template
       self.load_encoding = load_encoding
       self.password = password
       self.use_non_merge_fields = use_non_merge_fields
@@ -57,8 +57,8 @@ module AsposeWordsCloud
 
     # Creating batch part from request
     def to_batch_part(api_client)
-      # verify the required parameter 'document' is set
-      raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_document_field_names_online' if api_client.config.client_side_validation && self.document.nil?
+      # verify the required parameter 'template' is set
+      raise ArgumentError, 'Missing the required parameter template when calling WordsApi.get_document_field_names_online' if api_client.config.client_side_validation && self.template.nil?
 
       # resource path
       local_var_path = '/words/online/get/mailMerge/FieldNames'[7..-1]
@@ -81,7 +81,7 @@ module AsposeWordsCloud
 
       # form parameters
       form_params = {}
-      form_params[downcase_first_letter('Document')] = self.document
+      form_params[downcase_first_letter('Template')] = self.template
 
       # http body (model)
       post_body = nil
@@ -107,8 +107,8 @@ module AsposeWordsCloud
     end
 
     def create_http_request(api_client)
-      # verify the required parameter 'document' is set
-      raise ArgumentError, 'Missing the required parameter document when calling WordsApi.get_document_field_names_online' if api_client.config.client_side_validation && self.document.nil?
+      # verify the required parameter 'template' is set
+      raise ArgumentError, 'Missing the required parameter template when calling WordsApi.get_document_field_names_online' if api_client.config.client_side_validation && self.template.nil?
 
       # resource path
       local_var_path = '/words/online/get/mailMerge/FieldNames'[1..-1]
@@ -127,7 +127,7 @@ module AsposeWordsCloud
 
       # form parameters
       form_params = {}
-      form_params[downcase_first_letter('Document')] = self.document
+      form_params[downcase_first_letter('Template')] = self.template
 
       # http body (model)
       post_body = nil

data/lib/aspose_words_cloud/models/requests/get_document_field_names_request.rb

@@ -56,7 +56,7 @@ module AsposeWordsCloud
     # @param password Password for opening an encrypted document.
     # @param use_non_merge_fields The flag indicating whether to use non merge fields. If true, result includes "mustache" field names.
 
-    def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, use_non_merge_fields = nil)
+    def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, use_non_merge_fields: nil)
       self.name = name
       self.folder = folder
       self.storage = storage

data/lib/aspose_words_cloud/models/requests/get_document_hyperlink_by_index_online_request.rb

@@ -48,7 +48,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, hyperlink_index, load_encoding = nil, password = nil)
+    def initialize(document:, hyperlink_index:, load_encoding: nil, password: nil)
       self.document = document
       self.hyperlink_index = hyperlink_index
       self.load_encoding = load_encoding

data/lib/aspose_words_cloud/models/requests/get_document_hyperlink_by_index_request.rb

@@ -56,7 +56,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, hyperlink_index, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, hyperlink_index:, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.hyperlink_index = hyperlink_index
       self.folder = folder

data/lib/aspose_words_cloud/models/requests/get_document_hyperlinks_online_request.rb

@@ -44,7 +44,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, load_encoding = nil, password = nil)
+    def initialize(document:, load_encoding: nil, password: nil)
       self.document = document
       self.load_encoding = load_encoding
       self.password = password

data/lib/aspose_words_cloud/models/requests/get_document_hyperlinks_request.rb

@@ -52,7 +52,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.folder = folder
       self.storage = storage

data/lib/aspose_words_cloud/models/requests/get_document_properties_online_request.rb

@@ -44,7 +44,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, load_encoding = nil, password = nil)
+    def initialize(document:, load_encoding: nil, password: nil)
       self.document = document
       self.load_encoding = load_encoding
       self.password = password

data/lib/aspose_words_cloud/models/requests/get_document_properties_request.rb

@@ -52,7 +52,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.folder = folder
       self.storage = storage

data/lib/aspose_words_cloud/models/requests/get_document_property_online_request.rb

@@ -48,7 +48,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, property_name, load_encoding = nil, password = nil)
+    def initialize(document:, property_name:, load_encoding: nil, password: nil)
       self.document = document
       self.property_name = property_name
       self.load_encoding = load_encoding

data/lib/aspose_words_cloud/models/requests/get_document_property_request.rb

@@ -56,7 +56,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, property_name, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, property_name:, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.property_name = property_name
       self.folder = folder

data/lib/aspose_words_cloud/models/requests/get_document_protection_online_request.rb

@@ -44,7 +44,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document, load_encoding = nil, password = nil)
+    def initialize(document:, load_encoding: nil, password: nil)
       self.document = document
       self.load_encoding = load_encoding
       self.password = password

data/lib/aspose_words_cloud/models/requests/get_document_protection_request.rb

@@ -52,7 +52,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.name = name
       self.folder = folder
       self.storage = storage

data/lib/aspose_words_cloud/models/requests/get_document_request.rb

@@ -52,7 +52,7 @@ module AsposeWordsCloud
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
 
-    def initialize(document_name, folder = nil, storage = nil, load_encoding = nil, password = nil)
+    def initialize(document_name:, folder: nil, storage: nil, load_encoding: nil, password: nil)
       self.document_name = document_name
       self.folder = folder
       self.storage = storage

data/lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb

@@ -56,7 +56,7 @@ module AsposeWordsCloud
     # @param include_footnotes The flag indicating whether to include footnotes from the WordCount. The default value is "false".
     # @param include_text_in_shapes The flag indicating whether to include shape's text from the WordCount. The default value is "false".
 
-    def initialize(document, load_encoding = nil, password = nil, include_comments = nil, include_footnotes = nil, include_text_in_shapes = nil)
+    def initialize(document:, load_encoding: nil, password: nil, include_comments: nil, include_footnotes: nil, include_text_in_shapes: nil)
       self.document = document
       self.load_encoding = load_encoding
       self.password = password

data/lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb

@@ -64,7 +64,7 @@ module AsposeWordsCloud
     # @param include_footnotes The flag indicating whether to include footnotes from the WordCount. The default value is "false".
     # @param include_text_in_shapes The flag indicating whether to include shape's text from the WordCount. The default value is "false".
 
-    def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, include_comments = nil, include_footnotes = nil, include_text_in_shapes = nil)
+    def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, include_comments: nil, include_footnotes: nil, include_text_in_shapes: nil)
       self.name = name
       self.folder = folder
       self.storage = storage