aspose_words_cloud 21.1.0 → 21.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 748c9b54750e7ba9c6a9578ff2609ba6f65bfa955cfec588379f9be39f6a90da
-  data.tar.gz: 5f1595ec466432a1f50a794f4a23cf99499944b94fe28abcc82d72a51fae72f7
+  metadata.gz: b3c4f597c586d77582857d9a1bd8bc8b4012965b134f9bf00e4c2e1f4a259ebd
+  data.tar.gz: 3911c21501f8075351af2d2180a2b8d5167ebcdcc53b0d88a068790765312f14
 SHA512:
-  metadata.gz: 2270e45970daebdbb0d3aa76d98d1ec622b9029158ddc6466350b1310d1527b14e93e0a3ab3ae5b7a32d3877751ce0ff3d3feaff736ce07785cdd70adb00c32d
-  data.tar.gz: 1db96e9a843ca4a50707cc7daec63f9b87f134ffa918b641c95854a376db44f5222b2c9d0296bb8f3923afa758331131246e2ce05fbe0e9a89cbab02be8fc0e8
+  metadata.gz: 7863bb3ccacf4ae46d4e4f107d247c6e39cc782006cc6e8807e099b48aee46c832dba970e7c836f30d66b1585bd30a959567c4ca4bed29a0fbafef0f988e12e6
+  data.tar.gz: 4171c8ff5b8edb2fb50750c5890790991efcda9a55a6f05c194e9ceba084ccad7712ce5c3d67b0f5b8dd323b5631245fa6b85b201f3cffa4b0491c6d94310162

data/lib/aspose_words_cloud.rb

@@ -258,6 +258,7 @@ require_relative 'aspose_words_cloud/models/tab_stop_insert'
 require_relative 'aspose_words_cloud/models/tab_stops_response'
 require_relative 'aspose_words_cloud/models/text_save_options_data'
 require_relative 'aspose_words_cloud/models/tiff_save_options_data'
+require_relative 'aspose_words_cloud/models/time_zone_info_data'
 require_relative 'aspose_words_cloud/models/txt_save_options_base_data'
 require_relative 'aspose_words_cloud/models/watermark_text'
 require_relative 'aspose_words_cloud/models/word_ml_save_options_data'
@@ -300,6 +301,8 @@ require_relative 'aspose_words_cloud/models/requests/delete_borders_request'
 require_relative 'aspose_words_cloud/models/requests/delete_borders_online_request'
 require_relative 'aspose_words_cloud/models/requests/delete_comment_request'
 require_relative 'aspose_words_cloud/models/requests/delete_comment_online_request'
+require_relative 'aspose_words_cloud/models/requests/delete_comments_request'
+require_relative 'aspose_words_cloud/models/requests/delete_comments_online_request'
 require_relative 'aspose_words_cloud/models/requests/delete_document_property_request'
 require_relative 'aspose_words_cloud/models/requests/delete_document_property_online_request'
 require_relative 'aspose_words_cloud/models/requests/delete_drawing_object_request'

data/lib/aspose_words_cloud/api/words_api.rb

@@ -25,6 +25,7 @@
 
 require 'uri'
 require 'json'
+require 'faraday'
 
 module AsposeWordsCloud
   #
@@ -40,6 +41,26 @@ module AsposeWordsCloud
       request_token
     end
 
+    def batch(requests)
+      raise ArgumentError, 'Requests array is nil' unless requests != nil
+      raise ArgumentError, 'There must be at least one request' unless requests.length != 0
+      form_params = {}
+      request_token
+      header_params = {'Content-Type' => 'multipart/form-data'}
+      @api_client.update_params_for_auth! header_params, {}, "JWT"
+      requests.each_with_index do |request, index|
+        form_params["request-#{index}"] = Faraday::ParamPart.new(request.to_batch_part(@api_client), "application/http; msgtype=request")
+      end
+      data, status_code, headers = @api_client.call_api(:PUT, "/v4.0/words/batch",
+                                                        header_params: header_params,
+                                                        query_params: {},
+                                                        form_params: form_params,
+                                                        body: nil,
+                                                        batch: true,
+                                                        parts: requests,
+                                                        auth_names: ['JWT'])
+    end
+
     # Accepts all revisions in the document.
     # @param request AcceptAllRevisionsRequest
     # @return [RevisionsModificationResponse]
@@ -2237,6 +2258,147 @@ module AsposeWordsCloud
         [data, status_code, headers]
     end
 
+    # Removes all comments from the document.
+    # @param request DeleteCommentsRequest
+    # @return [nil]
+    def delete_comments(request)
+        begin
+        data, _status_code, _headers = delete_comments_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = delete_comments_with_http_info(request)
+            else
+            raise
+            end
+        end
+        nil
+    end
+
+    # Removes all comments from the document.
+    # @param request DeleteCommentsRequest
+    # @return [Array<(nil, Fixnum, Hash)>]
+    # nil, response status code and response headers
+    private def delete_comments_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? DeleteCommentsRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.delete_comments ...' if @api_client.config.debugging
+        # verify the required parameter 'name' is set
+        raise ArgumentError, 'Missing the required parameter name when calling WordsApi.delete_comments' if @api_client.config.client_side_validation && request.name.nil?
+
+        # resource path
+        local_var_path = '/words/{name}/comments'[1..-1]
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', request.name.nil? ? '' : request.name.to_s)
+        local_var_path = local_var_path.sub('//', '/')
+
+        # query parameters
+        query_params = {}
+        query_params[downcase_first_letter('Folder')] = request.folder unless request.folder.nil?
+        query_params[downcase_first_letter('Storage')] = request.storage unless request.storage.nil?
+        query_params[downcase_first_letter('LoadEncoding')] = request.load_encoding unless request.load_encoding.nil?
+        query_params[downcase_first_letter('Password')] = request.password unless request.password.nil?
+        query_params[downcase_first_letter('DestFileName')] = request.dest_file_name unless request.dest_file_name.nil?
+        query_params[downcase_first_letter('RevisionAuthor')] = request.revision_author unless request.revision_author.nil?
+        query_params[downcase_first_letter('RevisionDateTime')] = request.revision_date_time unless request.revision_date_time.nil?
+
+        # header parameters
+        header_params = {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/xml', 'application/json'])
+        # 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
+        auth_names = ['JWT']
+
+        data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        auth_names: auth_names)
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#delete_comments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [data, status_code, headers]
+    end
+
+    # Removes all comments from the document.
+    # @param request DeleteCommentsOnlineRequest
+    # @return [File]
+    def delete_comments_online(request)
+        begin
+        data, _status_code, _headers = delete_comments_online_with_http_info(request)
+        rescue ApiError => e
+            if e.code == 401
+            request_token
+            data, _status_code, _headers = delete_comments_online_with_http_info(request)
+            else
+            raise
+            end
+        end
+        data
+    end
+
+    # Removes all comments from the document.
+    # @param request DeleteCommentsOnlineRequest
+    # @return [Array<(File, Fixnum, Hash)>]
+    # File, response status code and response headers
+    private def delete_comments_online_with_http_info(request)
+        raise ArgumentError, 'Incorrect request type' unless request.is_a? DeleteCommentsOnlineRequest
+
+        @api_client.config.logger.debug 'Calling API: WordsApi.delete_comments_online ...' if @api_client.config.debugging
+        # verify the required parameter 'document' is set
+        raise ArgumentError, 'Missing the required parameter document when calling WordsApi.delete_comments_online' if @api_client.config.client_side_validation && request.document.nil?
+
+        # resource path
+        local_var_path = '/words/online/delete/comments'[1..-1]
+        local_var_path = local_var_path.sub('//', '/')
+
+        # query parameters
+        query_params = {}
+        query_params[downcase_first_letter('LoadEncoding')] = request.load_encoding unless request.load_encoding.nil?
+        query_params[downcase_first_letter('Password')] = request.password unless request.password.nil?
+        query_params[downcase_first_letter('DestFileName')] = request.dest_file_name unless request.dest_file_name.nil?
+        query_params[downcase_first_letter('RevisionAuthor')] = request.revision_author unless request.revision_author.nil?
+        query_params[downcase_first_letter('RevisionDateTime')] = request.revision_date_time unless request.revision_date_time.nil?
+
+        # header parameters
+        header_params = {}
+        # HTTP header 'Accept' (if needed)
+        header_params['Accept'] = @api_client.select_header_accept(['application/xml', 'application/json'])
+        # HTTP header 'Content-Type'
+        header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+        # form parameters
+        form_params = {}
+        form_params[downcase_first_letter('Document')] = request.document
+
+        # http body (model)
+        post_body = nil
+        auth_names = ['JWT']
+
+        data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        auth_names: auth_names,
+                                                        return_type: 'File')
+        if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        WordsApi#delete_comments_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        end
+
+        [data, status_code, headers]
+    end
+
     # Removes a document property.
     # @param request DeleteDocumentPropertyRequest
     # @return [nil]

data/lib/aspose_words_cloud/api_client.rb

@@ -29,7 +29,7 @@ require 'logger'
 require 'tempfile'
 require 'uri'
 require 'faraday'
-require 'mimemagic'
+require 'marcel'
 require 'multipart_parser/reader'
 require_relative 'version'
 require_relative 'api_error'
@@ -96,6 +96,8 @@ module AsposeWordsCloud
 
       if opts[:multipart_response] == true
         data = deserialize_multipart(response)
+      elsif opts[:batch] == true
+        data = deserialize_batch(response, opts[:parts])
       else
         data = deserialize(response.body, opts[:return_type]) if opts[:return_type]
       end
@@ -223,6 +225,50 @@ module AsposeWordsCloud
       parts
     end
 
+    # Deserialize batch
+    def deserialize_batch(response, requests)
+      result = { errors: [], parts: [] }
+      def result.part(name)
+        hash = self[:parts].detect { |h| h[:part].name == name }
+        [hash[:part], hash[:body].join]
+      end
+      responses_data = []
+      content_type = response.headers['content-type']
+      reader = MultipartParser::Reader.new(MultipartParser::Reader::extract_boundary_value(content_type))
+      reader.on_part do |part|
+        result[:parts] << thispart = {
+          part: part,
+          body: []
+        }
+        part.on_data do |chunk|
+          thispart[:body] << chunk
+        end
+      end
+      reader.on_error do |msg|
+        result[:errors] << msg
+      end
+      reader.write response.body
+      reader.ended? or raise Exception, 'Truncated multipart message'
+
+      separator = "\r\n\r\n"
+      result[:parts].each do |part|
+        part[:body] = part[:body].join("")
+        part_body = part[:body]
+        data_index = part_body.index(separator)
+        if data_index != nil
+          header_data = part_body[0..data_index]
+          body_data = part_body[data_index+separator.length, part_body.length]
+          part[:body] = body_data
+        end
+      end
+
+      result[:parts].each_with_index do |response_data, index|
+        return_type = requests[index].get_response_type
+        responses_data.push(deserialize(response_data[:body], return_type))
+      end
+      responses_data
+    end
+
     # Convert data to the given return type.
     # @param [Object] data Data to be converted
     # @param [String] return_type Return type
@@ -339,14 +385,43 @@ module AsposeWordsCloud
     # @return [String] HTTP body data in the form of string
     def build_request_body(header_params, form_params, body)
       # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
-          header_params['Content-Type'] == 'multipart/form-data'
+      if header_params['Content-Type']['application/x-www-form-urlencoded'] ||
+          header_params['Content-Type']['multipart/form-data']
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when ::File, ::Tempfile
+            data[key] = Faraday::UploadIO.new(value.path, Marcel::Magic.by_magic(value).to_s, key)
+          when ::Array, nil, Faraday::ParamPart
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body_batch(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type']['application/x-www-form-urlencoded'] ||
+        header_params['Content-Type']['multipart/form-data']
         data = {}
         form_params.each do |key, value|
           case value
-          when ::File
-            data[key] = Faraday::UploadIO.new(value.path, MimeMagic.by_magic(value).to_s, key)
-          when ::Array, nil
+          when ::File, ::Tempfile
+            data[key] = File.open(value.path, 'rb') { |f| f.read }
+          when ::Array, nil, Faraday::ParamPart
             data[key] = value
           else
             data[key] = value.to_s
@@ -360,6 +435,18 @@ module AsposeWordsCloud
       data
     end
 
+    # Append query parameter to url
+    #
+    # @param [String] url current url
+    # @param [String] param_name query parameter name
+    # @param [String] param_value query parameter value
+    def add_param_to_query(url, param_name, param_value)
+      uri = URI(url)
+      params = URI.decode_www_form(uri.query || "") << [param_name, param_value]
+      uri.query = URI.encode_www_form(params)
+      uri.to_s
+    end
+
     # Update hearder and query params based on authentication settings.
     #
     # @param [Hash] header_params Header parameters

data/lib/aspose_words_cloud/configuration.rb

@@ -119,7 +119,8 @@ module AsposeWordsCloud
         return URI.join(baseUrl, path).to_s
       end
 
-      return URI.join(baseUrl, "/v4.0/", URI.encode(path)).to_s
+      p = URI::Parser.new
+      URI.join(baseUrl, "/v4.0/", p.escape(path)).to_s
     end
 
     # Gets API key (with prefix if set).

data/lib/aspose_words_cloud/models/bmp_save_options_data.rb

@@ -29,6 +29,12 @@ module AsposeWordsCloud
 
   # Container class for bmp save options.
   class BmpSaveOptionsData
+    # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    attr_accessor :allow_embedding_post_script_fonts
+
+    # Gets or sets CustomTimeZoneInfo.
+    attr_accessor :custom_time_zone_info_data
+
     # Gets or sets the value determining how 3D effects are rendered.
     attr_accessor :dml3_d_effects_rendering_mode
 
@@ -45,6 +51,10 @@ module AsposeWordsCloud
     # Gets or sets the format of save.
     attr_accessor :save_format
 
+    # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
+    # Default value is false.
+    attr_accessor :update_created_time_property
+
     # 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.
     attr_accessor :update_fields
 
@@ -155,11 +165,14 @@ module AsposeWordsCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'allow_embedding_post_script_fonts' => :'AllowEmbeddingPostScriptFonts',
+        :'custom_time_zone_info_data' => :'CustomTimeZoneInfoData',
         :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode',
         :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
         :'dml_rendering_mode' => :'DmlRenderingMode',
         :'file_name' => :'FileName',
         :'save_format' => :'SaveFormat',
+        :'update_created_time_property' => :'UpdateCreatedTimeProperty',
         :'update_fields' => :'UpdateFields',
         :'update_last_printed_property' => :'UpdateLastPrintedProperty',
         :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
@@ -191,11 +204,14 @@ module AsposeWordsCloud
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'allow_embedding_post_script_fonts' => :'BOOLEAN',
+        :'custom_time_zone_info_data' => :'TimeZoneInfoData',
         :'dml3_d_effects_rendering_mode' => :'String',
         :'dml_effects_rendering_mode' => :'String',
         :'dml_rendering_mode' => :'String',
         :'file_name' => :'String',
         :'save_format' => :'String',
+        :'update_created_time_property' => :'BOOLEAN',
         :'update_fields' => :'BOOLEAN',
         :'update_last_printed_property' => :'BOOLEAN',
         :'update_last_saved_time_property' => :'BOOLEAN',
@@ -232,6 +248,14 @@ module AsposeWordsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.key?(:'AllowEmbeddingPostScriptFonts')
+        self.allow_embedding_post_script_fonts = attributes[:'AllowEmbeddingPostScriptFonts']
+      end
+
+      if attributes.key?(:'CustomTimeZoneInfoData')
+        self.custom_time_zone_info_data = attributes[:'CustomTimeZoneInfoData']
+      end
+
       if attributes.key?(:'Dml3DEffectsRenderingMode')
         self.dml3_d_effects_rendering_mode = attributes[:'Dml3DEffectsRenderingMode']
       end
@@ -252,6 +276,10 @@ module AsposeWordsCloud
         self.save_format = attributes[:'SaveFormat']
       end
 
+      if attributes.key?(:'UpdateCreatedTimeProperty')
+        self.update_created_time_property = attributes[:'UpdateCreatedTimeProperty']
+      end
+
       if attributes.key?(:'UpdateFields')
         self.update_fields = attributes[:'UpdateFields']
       end
@@ -389,11 +417,14 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
+          allow_embedding_post_script_fonts == other.allow_embedding_post_script_fonts &&
+          custom_time_zone_info_data == other.custom_time_zone_info_data &&
           dml3_d_effects_rendering_mode == other.dml3_d_effects_rendering_mode &&
           dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
           dml_rendering_mode == other.dml_rendering_mode &&
           file_name == other.file_name &&
           save_format == other.save_format &&
+          update_created_time_property == other.update_created_time_property &&
           update_fields == other.update_fields &&
           update_last_printed_property == other.update_last_printed_property &&
           update_last_saved_time_property == other.update_last_saved_time_property &&
@@ -430,7 +461,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, save_format, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, graphics_quality_options, horizontal_resolution, image_brightness, image_color_mode, image_contrast, paper_color, pixel_format, resolution, scale, use_anti_aliasing, use_gdi_emf_renderer, use_high_quality_rendering, vertical_resolution].hash
+      [allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, save_format, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, graphics_quality_options, horizontal_resolution, image_brightness, image_color_mode, image_contrast, paper_color, pixel_format, resolution, scale, use_anti_aliasing, use_gdi_emf_renderer, use_high_quality_rendering, vertical_resolution].hash
     end
 
     # Builds the object from hash