cloudmersive-convert-api-client 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b30c48f88af80c84d8893c402e548b8a519596278dc44878576468d46379cc8d
-  data.tar.gz: 0203e72091ab09cb590f8b3cfc4d2c6a7efe96182c7e4aabf0a00457fc5a0f66
+  metadata.gz: 404bc80eb7731a18c1fc3046dc02c22aecda5b6e898de803aaaca9e0a3bdf1fe
+  data.tar.gz: ed17bc0db457680bcac102109cb88ec6fa754dea7505b8759e7c645cc3ea1944
 SHA512:
-  metadata.gz: 4da37c1b5ef1e2993504ad04016fe7b2257c77ea64cbe8527d0f49b7bf9d73b2376eb6eca17a6a25efb975a49135b8f9a10656475dbdaada50e8ed1e543acdab
-  data.tar.gz: 2337e002e016087c30681da6a015ec4c34c056eec53cd8a678af64dc309ba71f83711c97782eab52d08a41bb503648b6cdd43dc1ce2416ffb7a25b5ea98009ea
+  metadata.gz: d7dfc670d2965397b617fe0ea2ad0b68d636c0f9505e6e233f2e3b6c8ddf122e1811e282bd100fdf5435676ee8c6d7113eb3029c8b6fe4f96e60a73abaf6c18b
+  data.tar.gz: acf3228cd98c3fbef834a7e2e7fe4a5fb1bb93313f67d5ea33de4585d5df570b629ce302ad6c1714c2c4f3218ed7559e14aec7c26f577b03a98aa718d060d78e

data/README.md

@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 1.6.2
+- Package version: 1.6.3
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-convert-api-client-1.6.2.gem
+gem install ./cloudmersive-convert-api-client-1.6.3.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.3.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-convert-api-client', '~> 1.6.2'
+    gem 'cloudmersive-convert-api-client', '~> 1.6.3'
 
 ### Install from Git
 

data/docs/ConvertDocumentApi.md

@@ -198,7 +198,7 @@ Name | Type | Description  | Notes
 
 
 # **convert_document_autodetect_to_txt**
-> TextConversionResult convert_document_autodetect_to_txt(input_file)
+> TextConversionResult convert_document_autodetect_to_txt(input_file, opts)
 
 Convert Document to Text (txt)
 
@@ -220,10 +220,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
 
 input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
 
+opts = { 
+  text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
+}
 
 begin
   #Convert Document to Text (txt)
-  result = api_instance.convert_document_autodetect_to_txt(input_file)
+  result = api_instance.convert_document_autodetect_to_txt(input_file, opts)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
   puts "Exception when calling ConvertDocumentApi->convert_document_autodetect_to_txt: #{e}"
@@ -235,6 +238,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'. | [optional] 
 
 ### Return type
 
@@ -954,7 +958,7 @@ Name | Type | Description  | Notes
 
 
 # **convert_document_pdf_to_txt**
-> TextConversionResult convert_document_pdf_to_txt(input_file)
+> TextConversionResult convert_document_pdf_to_txt(input_file, opts)
 
 Convert PDF Document to Text (txt)
 
@@ -976,10 +980,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDocumentApi.new
 
 input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
 
+opts = { 
+  text_formatting_mode: "text_formatting_mode_example" # String | Optional; specify how whitespace should be handled when converting PDF to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
+}
 
 begin
   #Convert PDF Document to Text (txt)
-  result = api_instance.convert_document_pdf_to_txt(input_file)
+  result = api_instance.convert_document_pdf_to_txt(input_file, opts)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
   puts "Exception when calling ConvertDocumentApi->convert_document_pdf_to_txt: #{e}"
@@ -991,6 +998,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
+ **text_formatting_mode** | **String**| Optional; specify how whitespace should be handled when converting PDF to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'. | [optional] 
 
 ### Return type
 

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

@@ -192,6 +192,7 @@ module CloudmersiveConvertApiClient
     # Automatically detect file type and convert it to Text.  Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.  For spreadsheets, all worksheets will be included.  If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :text_formatting_mode Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
     # @return [TextConversionResult]
     def convert_document_autodetect_to_txt(input_file, opts = {})
       data, _status_code, _headers = convert_document_autodetect_to_txt_with_http_info(input_file, opts)
@@ -202,6 +203,7 @@ module CloudmersiveConvertApiClient
     # Automatically detect file type and convert it to Text.  Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.  For spreadsheets, all worksheets will be included.  If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :text_formatting_mode Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
     # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
     def convert_document_autodetect_to_txt_with_http_info(input_file, opts = {})
       if @api_client.config.debugging
@@ -223,6 +225,7 @@ module CloudmersiveConvertApiClient
       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[:'textFormattingMode'] = opts[:'text_formatting_mode'] if !opts[:'text_formatting_mode'].nil?
 
       # form parameters
       form_params = {}
@@ -976,6 +979,7 @@ module CloudmersiveConvertApiClient
     # PDF document to text
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :text_formatting_mode Optional; specify how whitespace should be handled when converting PDF to text.  Possible values are &#39;preserveWhitespace&#39; which will attempt to preserve whitespace in the document and relative positioning of text within the document, and &#39;minimizeWhitespace&#39; which will not insert additional spaces into the document in most cases.  Default is &#39;preserveWhitespace&#39;.
     # @return [TextConversionResult]
     def convert_document_pdf_to_txt(input_file, opts = {})
       data, _status_code, _headers = convert_document_pdf_to_txt_with_http_info(input_file, opts)
@@ -986,6 +990,7 @@ module CloudmersiveConvertApiClient
     # PDF document to text
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :text_formatting_mode Optional; specify how whitespace should be handled when converting PDF to text.  Possible values are &#39;preserveWhitespace&#39; which will attempt to preserve whitespace in the document and relative positioning of text within the document, and &#39;minimizeWhitespace&#39; which will not insert additional spaces into the document in most cases.  Default is &#39;preserveWhitespace&#39;.
     # @return [Array<(TextConversionResult, Fixnum, Hash)>] TextConversionResult data, response status code and response headers
     def convert_document_pdf_to_txt_with_http_info(input_file, opts = {})
       if @api_client.config.debugging
@@ -1007,6 +1012,7 @@ module CloudmersiveConvertApiClient
       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[:'textFormattingMode'] = opts[:'text_formatting_mode'] if !opts[:'text_formatting_mode'].nil?
 
       # form parameters
       form_params = {}

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

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

data/spec/api/convert_document_api_spec.rb

@@ -73,6 +73,7 @@ describe 'ConvertDocumentApi' do
   # Automatically detect file type and convert it to Text.  Supports all of the major Office document file formats including Word (DOCX, DOC), Excel (XLSX, XLS), PowerPoint (PPTX, PPT) and PDF files.  For spreadsheets, all worksheets will be included.  If you wish to exclude certain pages, worksheets, slides, etc. use the Split document API first, or the delete pages/slides/worksheet APIs first to adjust the document to the target state prior to converting to text.
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :text_formatting_mode Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
   # @return [TextConversionResult]
   describe 'convert_document_autodetect_to_txt test' do
     it "should work" do
@@ -241,6 +242,7 @@ describe 'ConvertDocumentApi' do
   # PDF document to text
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :text_formatting_mode Optional; specify how whitespace should be handled when converting PDF to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'preserveWhitespace'.
   # @return [TextConversionResult]
   describe 'convert_document_pdf_to_txt test' do
     it "should work" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-convert-api-client
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus