cloudmersive-convert-api-client 1.7.4 → 1.7.5

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

@@ -22,21 +22,45 @@ module CloudmersiveConvertApiClient
 
     # Compress files to create a new zip archive
     # Create a new zip archive by compressing input files.
+    # @param input_file1 First input file to perform the operation on.
     # @param [Hash] opts the optional parameters
-    # @return [Object]
-    def zip_archive_zip_create(opts = {})
-      data, _status_code, _headers = zip_archive_zip_create_with_http_info(opts)
+    # @option opts [File] :input_file2 Second input file to perform the operation on.
+    # @option opts [File] :input_file3 Third input file to perform the operation on.
+    # @option opts [File] :input_file4 Fourth input file to perform the operation on.
+    # @option opts [File] :input_file5 Fifth input file to perform the operation on.
+    # @option opts [File] :input_file6 Sixth input file to perform the operation on.
+    # @option opts [File] :input_file7 Seventh input file to perform the operation on.
+    # @option opts [File] :input_file8 Eighth input file to perform the operation on.
+    # @option opts [File] :input_file9 Ninth input file to perform the operation on.
+    # @option opts [File] :input_file10 Tenth input file to perform the operation on.
+    # @return [String]
+    def zip_archive_zip_create(input_file1, opts = {})
+      data, _status_code, _headers = zip_archive_zip_create_with_http_info(input_file1, opts)
       return data
     end
 
     # Compress files to create a new zip archive
     # Create a new zip archive by compressing input files.
+    # @param input_file1 First input file to perform the operation on.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
-    def zip_archive_zip_create_with_http_info(opts = {})
+    # @option opts [File] :input_file2 Second input file to perform the operation on.
+    # @option opts [File] :input_file3 Third input file to perform the operation on.
+    # @option opts [File] :input_file4 Fourth input file to perform the operation on.
+    # @option opts [File] :input_file5 Fifth input file to perform the operation on.
+    # @option opts [File] :input_file6 Sixth input file to perform the operation on.
+    # @option opts [File] :input_file7 Seventh input file to perform the operation on.
+    # @option opts [File] :input_file8 Eighth input file to perform the operation on.
+    # @option opts [File] :input_file9 Ninth input file to perform the operation on.
+    # @option opts [File] :input_file10 Tenth input file to perform the operation on.
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def zip_archive_zip_create_with_http_info(input_file1, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ZipArchiveApi.zip_archive_zip_create ..."
       end
+      # verify the required parameter 'input_file1' is set
+      if @api_client.config.client_side_validation && input_file1.nil?
+        fail ArgumentError, "Missing the required parameter 'input_file1' when calling ZipArchiveApi.zip_archive_zip_create"
+      end
       # resource path
       local_var_path = "/convert/archive/zip/create"
 
@@ -47,9 +71,21 @@ module CloudmersiveConvertApiClient
       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'])
 
       # form parameters
       form_params = {}
+      form_params["inputFile1"] = input_file1
+      form_params["inputFile2"] = opts[:'input_file2'] if !opts[:'input_file2'].nil?
+      form_params["inputFile3"] = opts[:'input_file3'] if !opts[:'input_file3'].nil?
+      form_params["inputFile4"] = opts[:'input_file4'] if !opts[:'input_file4'].nil?
+      form_params["inputFile5"] = opts[:'input_file5'] if !opts[:'input_file5'].nil?
+      form_params["inputFile6"] = opts[:'input_file6'] if !opts[:'input_file6'].nil?
+      form_params["inputFile7"] = opts[:'input_file7'] if !opts[:'input_file7'].nil?
+      form_params["inputFile8"] = opts[:'input_file8'] if !opts[:'input_file8'].nil?
+      form_params["inputFile9"] = opts[:'input_file9'] if !opts[:'input_file9'].nil?
+      form_params["inputFile10"] = opts[:'input_file10'] if !opts[:'input_file10'].nil?
 
       # http body (model)
       post_body = nil
@@ -60,7 +96,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: ZipArchiveApi#zip_archive_zip_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -122,6 +158,124 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Decrypt and remove password protection on a zip file
+    # Decrypts and removes password protection from an encrypted zip file with the specified password
+    # @param input_file Input file to perform the operation on.
+    # @param zip_password Required; Password for the input archive
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def zip_archive_zip_decrypt(input_file, zip_password, opts = {})
+      data, _status_code, _headers = zip_archive_zip_decrypt_with_http_info(input_file, zip_password, opts)
+      return data
+    end
+
+    # Decrypt and remove password protection on a zip file
+    # Decrypts and removes password protection from an encrypted zip file with the specified password
+    # @param input_file Input file to perform the operation on.
+    # @param zip_password Required; Password for the input archive
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def zip_archive_zip_decrypt_with_http_info(input_file, zip_password, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ZipArchiveApi.zip_archive_zip_decrypt ..."
+      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 ZipArchiveApi.zip_archive_zip_decrypt"
+      end
+      # verify the required parameter 'zip_password' is set
+      if @api_client.config.client_side_validation && zip_password.nil?
+        fail ArgumentError, "Missing the required parameter 'zip_password' when calling ZipArchiveApi.zip_archive_zip_decrypt"
+      end
+      # resource path
+      local_var_path = "/convert/archive/zip/decrypt"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'zipPassword'] = zip_password
+
+      # 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 => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_decrypt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Encrypt and password protect a zip file
+    # Encrypts and password protects an existing zip file with the specified password and encryption algorithm
+    # @param encryption_request Encryption request
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def zip_archive_zip_encrypt_advanced(encryption_request, opts = {})
+      data, _status_code, _headers = zip_archive_zip_encrypt_advanced_with_http_info(encryption_request, opts)
+      return data
+    end
+
+    # Encrypt and password protect a zip file
+    # Encrypts and password protects an existing zip file with the specified password and encryption algorithm
+    # @param encryption_request Encryption request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def zip_archive_zip_encrypt_advanced_with_http_info(encryption_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ZipArchiveApi.zip_archive_zip_encrypt_advanced ..."
+      end
+      # verify the required parameter 'encryption_request' is set
+      if @api_client.config.client_side_validation && encryption_request.nil?
+        fail ArgumentError, "Missing the required parameter 'encryption_request' when calling ZipArchiveApi.zip_archive_zip_encrypt_advanced"
+      end
+      # resource path
+      local_var_path = "/convert/archive/zip/encrypt/advanced"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(encryption_request)
+      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 => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ZipArchiveApi#zip_archive_zip_encrypt_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Extract, decompress files and folders from a zip archive
     # Extracts a zip archive by decompressing files, and folders.
     # @param input_file Input file to perform the operation on.

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

@@ -18,7 +18,7 @@ module CloudmersiveConvertApiClient
     # The index of the paragraph; 0-based
     attr_accessor :paragraph_index
 
-    # The Path of the location of this object; leave blank for new tables
+    # The Path of the location of this Paragraph object; leave blank during creation
     attr_accessor :path
 
     # The content runs in the paragraph - this is where text is stored; similar to a span in HTML

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

@@ -18,7 +18,7 @@ module CloudmersiveConvertApiClient
     # Index of the run, 0-based
     attr_accessor :run_index
 
-    # The Path of the location of this object; leave blank for new tables
+    # The Path of the location of this Run object; leave blank for creation
     attr_accessor :path
 
     # Text items inside the run; this is where the actual text content is stored

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

@@ -18,7 +18,7 @@ module CloudmersiveConvertApiClient
     # Index of the text content in the run; 0-based
     attr_accessor :text_index
 
-    # The Path of the location of this object; leave blank for new tables
+    # The Path of the location of this Text object; leave blank for creation
     attr_accessor :path
 
     # Text string containing the text content of this text content item

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

@@ -0,0 +1,235 @@
+=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
+  # Input to a request to find matching paragraphs in a Word DOCX document
+  class FindDocxParagraphRequest
+    # Optional: Bytes of the input file to operate on
+    attr_accessor :input_file_bytes
+
+    # Optional: URL of a file to operate on as input.  This can be a public URL, or you can also use the begin-editing API to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
+    attr_accessor :input_file_url
+
+    # Required: The target string to search for in the paragraphs of the document
+    attr_accessor :find_string
+
+    # Optional: True to match case, false to ignore case when matching
+    attr_accessor :match_case
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_file_bytes' => :'InputFileBytes',
+        :'input_file_url' => :'InputFileUrl',
+        :'find_string' => :'FindString',
+        :'match_case' => :'MatchCase'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'input_file_bytes' => :'String',
+        :'input_file_url' => :'String',
+        :'find_string' => :'String',
+        :'match_case' => :'BOOLEAN'
+      }
+    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?(:'InputFileBytes')
+        self.input_file_bytes = attributes[:'InputFileBytes']
+      end
+
+      if attributes.has_key?(:'InputFileUrl')
+        self.input_file_url = attributes[:'InputFileUrl']
+      end
+
+      if attributes.has_key?(:'FindString')
+        self.find_string = attributes[:'FindString']
+      end
+
+      if attributes.has_key?(:'MatchCase')
+        self.match_case = attributes[:'MatchCase']
+      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
+      if !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        invalid_properties.push("invalid value for 'input_file_bytes', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
+      end
+
+      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 false if !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] input_file_bytes Value to be assigned
+    def input_file_bytes=(input_file_bytes)
+
+      if !input_file_bytes.nil? && input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        fail ArgumentError, "invalid value for 'input_file_bytes', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
+      end
+
+      @input_file_bytes = input_file_bytes
+    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 &&
+          input_file_bytes == o.input_file_bytes &&
+          input_file_url == o.input_file_url &&
+          find_string == o.find_string &&
+          match_case == o.match_case
+    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
+      [input_file_bytes, input_file_url, find_string, match_case].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