cloudmersive-convert-api-client 2.1.8 → 2.2.2

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

@@ -0,0 +1,196 @@
+=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.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveConvertApiClient
+  # Result of getting the sitemap URL of the input HTML document
+  class HtmlGetSitemapUrlResult
+    # True if the operation was successful, false otherwise
+    attr_accessor :successful
+
+    # HTML sitemap URL if present
+    attr_accessor :canonical_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'canonical_url' => :'CanonicalUrl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'canonical_url' => :'String'
+      }
+    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?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'CanonicalUrl')
+        self.canonical_url = attributes[:'CanonicalUrl']
+      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
+      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?
+      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 &&
+          successful == o.successful &&
+          canonical_url == o.canonical_url
+    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
+      [successful, canonical_url].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 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.4.14
 =end
 
 module CloudmersiveConvertApiClient
-  VERSION = '2.1.8'
+  VERSION = '2.2.2'
 end

data/spec/api/edit_document_api_spec.rb

@@ -405,7 +405,7 @@ describe 'EditDocumentApi' do
   end
 
   # unit tests for edit_document_docx_replace_multi
-  # Replace multiple strings in Word DOCX document
+  # Replace multiple strings in Word DOCX document, return result
   # Replace all instances of multiple strings in an Office Word Document (docx)
   # @param req_config Document string replacement configuration input
   # @param [Hash] opts the optional parameters
@@ -416,6 +416,18 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_docx_replace_multi_edit_session
+  # Replace multiple strings in Word DOCX document, return edit session
+  # Replace all instances of multiple strings in an Office Word Document (docx).  Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times.  Call the Finish Editing API to retrieve the final document once editing is complete.
+  # @param req_config Document string replacement configuration input
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentEditingEditSession]
+  describe 'edit_document_docx_replace_multi_edit_session test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_document_docx_replace_paragraph
   # Replace matching paragraphs in a Word DOCX document
   # Returns the edited Word Document (DOCX) format file with the matching paragraphs replaced as requested.  Replace a paragraph with another object such as an image.  Useful for performing templating operations.

data/spec/api/edit_html_api_spec.rb

@@ -32,6 +32,20 @@ describe 'EditHtmlApi' do
     end
   end
 
+  # unit tests for edit_html_html_append_header_tag
+  # Append an HTML tag to the HEAD section of an HTML Document
+  # Appends an HTML tag to the HEAD section of an HTML document.
+  # @param html_tag The HTML tag to append.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @return [String]
+  describe 'edit_html_html_append_header_tag test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_html_html_append_heading
   # Append a Heading to an HTML Document
   # Appends a heading to the end of an HTML document.
@@ -111,6 +125,19 @@ describe 'EditHtmlApi' do
     end
   end
 
+  # unit tests for edit_html_html_get_language
+  # Gets the language for the HTML document
+  # Retrieves the language code (e.g. \"en\" or \"de\") of an HTML document.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @return [HtmlGetLanguageResult]
+  describe 'edit_html_html_get_language test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_html_html_get_links
   # Extract resolved link URLs from HTML File
   # Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
@@ -125,4 +152,72 @@ describe 'EditHtmlApi' do
     end
   end
 
+  # unit tests for edit_html_html_get_rel_canonical
+  # Gets the rel canonical URL for the HTML document
+  # Gets the rel canonical URL of an HTML document.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @return [HtmlGetRelCanonicalUrlResult]
+  describe 'edit_html_html_get_rel_canonical test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for edit_html_html_get_sitemap
+  # Gets the sitemap URL for the HTML document
+  # Gets the sitemap link URL of an HTML document.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @return [HtmlGetSitemapUrlResult]
+  describe 'edit_html_html_get_sitemap test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for edit_html_html_set_language
+  # Sets the language for the HTML document
+  # Sets the language code of an HTML document.
+  # @param language_code The HTML langauge code to set.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @return [String]
+  describe 'edit_html_html_set_language test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for edit_html_html_set_rel_canonical
+  # Sets the rel canonical URL for the HTML document
+  # Sets the rel canonical URL of an HTML document.  This is useful for telling search engines and other indexers which pages are duplicates of eachother; any pages with the rel=canonical tag will be treated as duplicates of the canonical URL.
+  # @param canonical_url The HTML canonical URL to set.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @return [String]
+  describe 'edit_html_html_set_rel_canonical test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for edit_html_html_set_sitemap_url
+  # Sets the sitemap URL for the HTML document
+  # Sets the sitemap URL of an HTML document.
+  # @param sitemap_url The HTML sitemap URL to set.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @return [String]
+  describe 'edit_html_html_set_sitemap_url test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api/edit_pdf_api_spec.rb

@@ -193,6 +193,7 @@ describe 'EditPdfApi' do
   # Reduces the file size and optimizes the content of a PDF to minimize its file size.
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
+  # @option opts [Float] :quality Quality level for the images in the PDF, ranging from 0.0 (low quality) to 1.0 (high quality); default is 0.3
   # @return [String]
   describe 'edit_pdf_reduce_file_size test' do
     it 'should work' do

data/spec/api/merge_document_api_spec.rb

@@ -72,7 +72,7 @@ describe 'MergeDocumentApi' do
   # @param input_file1 First input file to perform the operation on.
   # @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
   # @param [Hash] opts the optional parameters
-  # @return [Object]
+  # @return [String]
   describe 'merge_document_html test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/api/transform_document_api_spec.rb

@@ -33,7 +33,7 @@ describe 'TransformDocumentApi' do
   end
 
   # unit tests for transform_document_docx_replace
-  # Replace string in Word DOCX document
+  # Replace string in Word DOCX document, return result
   # Replace all instances of a string in an Office Word Document (docx)
   # @param match_string String to search for and match against, to be replaced
   # @param replace_string String to replace the matched values with
@@ -48,8 +48,48 @@ describe 'TransformDocumentApi' do
     end
   end
 
+  # unit tests for transform_document_docx_replace_edit_session
+  # Replace string in Word DOCX document, return edit session
+  # Replace all instances of a string in an Office Word Document (docx).  Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times.  Call the Finish Editing API to retrieve the final document once editing is complete.
+  # @param match_string String to search for and match against, to be replaced
+  # @param replace_string String to replace the matched values with
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url 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 (part of EditDocumentApi) to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public).
+  # @option opts [BOOLEAN] :match_case Optional: True if the case should be matched, false for case insensitive match. Default is false.
+  # @return [DocumentTransformEditSession]
+  describe 'transform_document_docx_replace_edit_session test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for transform_document_docx_table_fill_in
+  # Fill in data in a table in a Word DOCX document, return result
+  # Replace placeholder rows ina  table in an Office Word Document (docx) using one or more templates
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'transform_document_docx_table_fill_in test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for transform_document_docx_table_fill_in_edit_session
+  # Fill in data in a table in a Word DOCX document, return edit session
+  # Replace placeholder rows ina  table in an Office Word Document (docx) using one or more templates.  Returns an edit session URL so that you can chain together multiple edit operations without having to send the entire document contents back and forth multiple times.  Call the Finish Editing API to retrieve the final document once editing is complete.
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentTransformEditSession]
+  describe 'transform_document_docx_table_fill_in_edit_session test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for transform_document_pptx_replace
-  # Replace string in PowerPoint PPTX presentation
+  # Replace string in PowerPoint PPTX presentation, return result
   # Replace all instances of a string in an Office PowerPoint Document (pptx)
   # @param match_string String to search for and match against, to be replaced
   # @param replace_string String to replace the matched values with

data/spec/models/document_editing_edit_session_spec.rb

@@ -0,0 +1,47 @@
+=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.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveConvertApiClient::DocumentEditingEditSession
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DocumentEditingEditSession' do
+  before do
+    # run before each test
+    @instance = CloudmersiveConvertApiClient::DocumentEditingEditSession.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DocumentEditingEditSession' do
+    it 'should create an instance of DocumentEditingEditSession' do
+      expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::DocumentEditingEditSession)
+    end
+  end
+  describe 'test attribute "successful"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "edit_session_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end