cloudmersive-convert-api-client 1.4.9 → 1.5.0

data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb

@@ -20,6 +20,76 @@ module CloudmersiveConvertApiClient
       @api_client = api_client
     end
 
+    # Remove / delete pages from a PDF document
+    # Remove one or more pages from a PDF document
+    # @param input_file Input file to perform the operation on.
+    # @param page_start Page number (1 based) to start deleting pages from (inclusive).
+    # @param page_end Page number (1 based) to stop deleting pages from (inclusive).
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def edit_pdf_delete_pages(input_file, page_start, page_end, opts = {})
+      data, _status_code, _headers = edit_pdf_delete_pages_with_http_info(input_file, page_start, page_end, opts)
+      return data
+    end
+
+    # Remove / delete pages from a PDF document
+    # Remove one or more pages from a PDF document
+    # @param input_file Input file to perform the operation on.
+    # @param page_start Page number (1 based) to start deleting pages from (inclusive).
+    # @param page_end Page number (1 based) to stop deleting pages from (inclusive).
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def edit_pdf_delete_pages_with_http_info(input_file, page_start, page_end, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditPdfApi.edit_pdf_delete_pages ..."
+      end
+      # verify the required parameter 'input_file' is set
+      if @api_client.config.client_side_validation && input_file.nil?
+        fail ArgumentError, "Missing the required parameter 'input_file' when calling EditPdfApi.edit_pdf_delete_pages"
+      end
+      # verify the required parameter 'page_start' is set
+      if @api_client.config.client_side_validation && page_start.nil?
+        fail ArgumentError, "Missing the required parameter 'page_start' when calling EditPdfApi.edit_pdf_delete_pages"
+      end
+      # verify the required parameter 'page_end' is set
+      if @api_client.config.client_side_validation && page_end.nil?
+        fail ArgumentError, "Missing the required parameter 'page_end' when calling EditPdfApi.edit_pdf_delete_pages"
+      end
+      # resource path
+      local_var_path = "/convert/edit/pdf/pages/delete"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'pageStart'] = page_start
+      header_params[:'pageEnd'] = page_end
+
+      # form parameters
+      form_params = {}
+      form_params["inputFile"] = input_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_delete_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Encrypt and password-protect a PDF
     # Encrypt a PDF document with a password.  Set an owner password to control owner (editor/creator) permissions, and set a user (reader) password to control the viewer of the PDF.  Set the password fields null to omit the given password.
     # @param input_file Input file to perform the operation on.
@@ -194,6 +264,90 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Insert / copy pages from one PDF document into another
+    # Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
+    # @param source_file Source PDF file to copy pages from.
+    # @param destination_file Destination PDF file to copy pages into.
+    # @param page_start_source Page number (1 based) to start copying pages from (inclusive) in the Source file.
+    # @param page_end_source Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
+    # @param page_insert_before_desitnation Page number (1 based) to insert the pages before in the Destination file.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def edit_pdf_insert_pages(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation, opts = {})
+      data, _status_code, _headers = edit_pdf_insert_pages_with_http_info(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation, opts)
+      return data
+    end
+
+    # Insert / copy pages from one PDF document into another
+    # Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
+    # @param source_file Source PDF file to copy pages from.
+    # @param destination_file Destination PDF file to copy pages into.
+    # @param page_start_source Page number (1 based) to start copying pages from (inclusive) in the Source file.
+    # @param page_end_source Page number (1 based) to stop copying pages pages from (inclusive) in the Source file.
+    # @param page_insert_before_desitnation Page number (1 based) to insert the pages before in the Destination file.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def edit_pdf_insert_pages_with_http_info(source_file, destination_file, page_start_source, page_end_source, page_insert_before_desitnation, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditPdfApi.edit_pdf_insert_pages ..."
+      end
+      # verify the required parameter 'source_file' is set
+      if @api_client.config.client_side_validation && source_file.nil?
+        fail ArgumentError, "Missing the required parameter 'source_file' when calling EditPdfApi.edit_pdf_insert_pages"
+      end
+      # verify the required parameter 'destination_file' is set
+      if @api_client.config.client_side_validation && destination_file.nil?
+        fail ArgumentError, "Missing the required parameter 'destination_file' when calling EditPdfApi.edit_pdf_insert_pages"
+      end
+      # verify the required parameter 'page_start_source' is set
+      if @api_client.config.client_side_validation && page_start_source.nil?
+        fail ArgumentError, "Missing the required parameter 'page_start_source' when calling EditPdfApi.edit_pdf_insert_pages"
+      end
+      # verify the required parameter 'page_end_source' is set
+      if @api_client.config.client_side_validation && page_end_source.nil?
+        fail ArgumentError, "Missing the required parameter 'page_end_source' when calling EditPdfApi.edit_pdf_insert_pages"
+      end
+      # verify the required parameter 'page_insert_before_desitnation' is set
+      if @api_client.config.client_side_validation && page_insert_before_desitnation.nil?
+        fail ArgumentError, "Missing the required parameter 'page_insert_before_desitnation' when calling EditPdfApi.edit_pdf_insert_pages"
+      end
+      # resource path
+      local_var_path = "/convert/edit/pdf/pages/insert"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'pageStartSource'] = page_start_source
+      header_params[:'pageEndSource'] = page_end_source
+      header_params[:'pageInsertBeforeDesitnation'] = page_insert_before_desitnation
+
+      # form parameters
+      form_params = {}
+      form_params["sourceFile"] = source_file
+      form_params["destinationFile"] = destination_file
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_insert_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Rasterize a PDF to an image-based PDF
     # Rasterize a PDF into an image-based PDF.  The output is a PDF where each page is comprised of a high-resolution image, with all text, figures and other components removed.
     # @param input_file Input file to perform the operation on.
@@ -309,7 +463,7 @@ module CloudmersiveConvertApiClient
     # Sets (writes) metadata into the input PDF document, including Title, Author, etc.
     # @param request 
     # @param [Hash] opts the optional parameters
-    # @return [Object]
+    # @return [String]
     def edit_pdf_set_metadata(request, opts = {})
       data, _status_code, _headers = edit_pdf_set_metadata_with_http_info(request, opts)
       return data
@@ -319,7 +473,7 @@ module CloudmersiveConvertApiClient
     # Sets (writes) metadata into the input PDF document, including Title, Author, etc.
     # @param request 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def edit_pdf_set_metadata_with_http_info(request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: EditPdfApi.edit_pdf_set_metadata ..."
@@ -353,7 +507,7 @@ module CloudmersiveConvertApiClient
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Object')
+        :return_type => 'String')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_set_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/cloudmersive-convert-api-client/models/html_to_png_request.rb

@@ -0,0 +1,219 @@
+=begin
+#convertapi
+
+#Convert API lets you effortlessly convert file formats and types.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'date'
+
+module CloudmersiveConvertApiClient
+  # Details of the HTML to PNG request
+  class HtmlToPngRequest
+    # HTML to render to PNG (screenshot)
+    attr_accessor :html
+
+    # Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.
+    attr_accessor :extra_loading_wait
+
+    # Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
+    attr_accessor :screenshot_width
+
+    # Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot
+    attr_accessor :screenshot_height
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'html' => :'Html',
+        :'extra_loading_wait' => :'ExtraLoadingWait',
+        :'screenshot_width' => :'ScreenshotWidth',
+        :'screenshot_height' => :'ScreenshotHeight'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'html' => :'String',
+        :'extra_loading_wait' => :'Integer',
+        :'screenshot_width' => :'Integer',
+        :'screenshot_height' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'Html')
+        self.html = attributes[:'Html']
+      end
+
+      if attributes.has_key?(:'ExtraLoadingWait')
+        self.extra_loading_wait = attributes[:'ExtraLoadingWait']
+      end
+
+      if attributes.has_key?(:'ScreenshotWidth')
+        self.screenshot_width = attributes[:'ScreenshotWidth']
+      end
+
+      if attributes.has_key?(:'ScreenshotHeight')
+        self.screenshot_height = attributes[:'ScreenshotHeight']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          html == o.html &&
+          extra_loading_wait == o.extra_loading_wait &&
+          screenshot_width == o.screenshot_width &&
+          screenshot_height == o.screenshot_height
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [html, extra_loading_wait, screenshot_width, screenshot_height].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveConvertApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/cloudmersive-convert-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
 =end
 
 module CloudmersiveConvertApiClient
-  VERSION = "1.4.9"
+  VERSION = "1.5.0"
 end

data/spec/api/convert_data_api_spec.rb

@@ -33,7 +33,7 @@ describe 'ConvertDataApi' do
   end
 
   # unit tests for convert_data_csv_to_json
-  # CSV to JSON conversion
+  # Convert CSV to JSON conversion
   # Convert a CSV file to a JSON object array
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
@@ -45,7 +45,7 @@ describe 'ConvertDataApi' do
   end
 
   # unit tests for convert_data_xls_to_json
-  # Excel (97-2003) XLS to JSON conversion
+  # Convert Excel (97-2003) XLS to JSON conversion
   # Convert an Excel (97-2003) XLS file to a JSON object array
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
@@ -57,7 +57,7 @@ describe 'ConvertDataApi' do
   end
 
   # unit tests for convert_data_xlsx_to_json
-  # Excel XLSX to JSON conversion
+  # Convert Excel XLSX to JSON conversion
   # Convert an Excel XLSX file to a JSON object array
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
@@ -69,7 +69,7 @@ describe 'ConvertDataApi' do
   end
 
   # unit tests for convert_data_xml_to_json
-  # XML to JSON conversion
+  # Convert XML to JSON conversion
   # Convert an XML string or file into JSON
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters