cloudmersive-convert-api-client 1.7.5 → 1.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd33579cf5967f09473a0affa369671112c65be5284192f24f99f4307b7a9d19
-  data.tar.gz: cf649e84729034b5abf1da7ab61fc8bb9609008433bccf4ac971df0222979a3e
+  metadata.gz: 03ebf8b3092912e7bb2347ac84cfc530be87dc42c157dda0409a8ab108738792
+  data.tar.gz: ab778551b685b740f6a151d2dfb48a501eed8492438303005d5e896530ce4053
 SHA512:
-  metadata.gz: 889df1a634674598296ba5ef89f9b9a207f70e7e36fcf960b3e3cca2e136563c011833df72e206b115b191a5e2e487be42b8801fe1fee43a29fe1dcc5d49ba28
-  data.tar.gz: 4e9e541beedef3d83d33b7eec3441b373ebb3b1093e03c4f18d20fc827445654d482e9d8e8b3e19b7948b73fcd4ff9cceefe27f86c7f703a3b7e4c1afc6d7bd3
+  metadata.gz: 435a627e9f6dc79aefcbfa8e9201f848840c8c18339e5f962f268f6866811e3030151988e46d3006c4393513e3b879e423ac9d4d8ce7adf11122e426b34c38c4
+  data.tar.gz: d0197210a982e1956d16542e10bc06770296d77016308f6b8b57bfd5d710d5bb09f65351a6400ca3214577745ae9b1ac87b760977fc24175970ca483906cad18

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.7.5
+- Package version: 1.7.6
 - 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.7.5.gem
+gem install ./cloudmersive-convert-api-client-1.7.6.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.5.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.7.6.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.7.5'
+    gem 'cloudmersive-convert-api-client', '~> 1.7.6'
 
 ### Install from Git
 
@@ -246,6 +246,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_txt_by_string**](docs/SplitDocumentApi.md#split_document_txt_by_string) | **POST** /convert/split/txt/by-string | Split a single Text file (txt) by a string delimiter
 *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
 *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_autodetect_validation**](docs/ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
+*CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_csv_validation**](docs/ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
 *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_docx_validation**](docs/ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
 *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_executable_validation**](docs/ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
 *CloudmersiveConvertApiClient::ValidateDocumentApi* | [**validate_document_g_zip_validation**](docs/ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)

data/docs/ConvertDataApi.md

@@ -22,7 +22,7 @@ Method | HTTP request | Description
 
 
 # **convert_data_csv_to_json**
-> Object convert_data_csv_to_json(input_file)
+> Object convert_data_csv_to_json(input_file, opts)
 
 Convert CSV to JSON conversion
 
@@ -44,10 +44,13 @@ api_instance = CloudmersiveConvertApiClient::ConvertDataApi.new
 
 input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
 
+opts = { 
+  column_names_from_first_row: true # BOOLEAN | Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
+}
 
 begin
   #Convert CSV to JSON conversion
-  result = api_instance.convert_data_csv_to_json(input_file)
+  result = api_instance.convert_data_csv_to_json(input_file, opts)
   p result
 rescue CloudmersiveConvertApiClient::ApiError => e
   puts "Exception when calling ConvertDataApi->convert_data_csv_to_json: #{e}"
@@ -59,6 +62,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
+ **column_names_from_first_row** | **BOOLEAN**| Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure. | [optional] 
 
 ### Return type
 

data/docs/ValidateDocumentApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**validate_document_autodetect_validation**](ValidateDocumentApi.md#validate_document_autodetect_validation) | **POST** /convert/validate/autodetect | Autodetect content type and validate
+[**validate_document_csv_validation**](ValidateDocumentApi.md#validate_document_csv_validation) | **POST** /convert/validate/csv | Validate a CSV file document (CSV)
 [**validate_document_docx_validation**](ValidateDocumentApi.md#validate_document_docx_validation) | **POST** /convert/validate/docx | Validate a Word document (DOCX)
 [**validate_document_executable_validation**](ValidateDocumentApi.md#validate_document_executable_validation) | **POST** /convert/validate/executable | Validate if a file is executable
 [**validate_document_g_zip_validation**](ValidateDocumentApi.md#validate_document_g_zip_validation) | **POST** /convert/validate/gzip | Validate a GZip Archive file (gzip or gz)
@@ -72,6 +73,60 @@ Name | Type | Description  | Notes
 
 
 
+# **validate_document_csv_validation**
+> DocumentValidationResult validate_document_csv_validation(input_file)
+
+Validate a CSV file document (CSV)
+
+Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-convert-api-client'
+# setup authorization
+CloudmersiveConvertApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveConvertApiClient::ValidateDocumentApi.new
+
+input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
+
+
+begin
+  #Validate a CSV file document (CSV)
+  result = api_instance.validate_document_csv_validation(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ValidateDocumentApi->validate_document_csv_validation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+
+### Return type
+
+[**DocumentValidationResult**](DocumentValidationResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **validate_document_docx_validation**
 > DocumentValidationResult validate_document_docx_validation(input_file)
 

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

@@ -24,6 +24,7 @@ module CloudmersiveConvertApiClient
     # 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
+    # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
     # @return [Object]
     def convert_data_csv_to_json(input_file, opts = {})
       data, _status_code, _headers = convert_data_csv_to_json_with_http_info(input_file, opts)
@@ -34,6 +35,7 @@ module CloudmersiveConvertApiClient
     # 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
+    # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
     # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
     def convert_data_csv_to_json_with_http_info(input_file, opts = {})
       if @api_client.config.debugging
@@ -55,6 +57,7 @@ module CloudmersiveConvertApiClient
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'columnNamesFromFirstRow'] = opts[:'column_names_from_first_row'] if !opts[:'column_names_from_first_row'].nil?
 
       # form parameters
       form_params = {}

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

@@ -76,6 +76,62 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Validate a CSV file document (CSV)
+    # Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [DocumentValidationResult]
+    def validate_document_csv_validation(input_file, opts = {})
+      data, _status_code, _headers = validate_document_csv_validation_with_http_info(input_file, opts)
+      return data
+    end
+
+    # Validate a CSV file document (CSV)
+    # Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DocumentValidationResult, Fixnum, Hash)>] DocumentValidationResult data, response status code and response headers
+    def validate_document_csv_validation_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ValidateDocumentApi.validate_document_csv_validation ..."
+      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 ValidateDocumentApi.validate_document_csv_validation"
+      end
+      # resource path
+      local_var_path = "/convert/validate/csv"
+
+      # 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'])
+
+      # 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 => 'DocumentValidationResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ValidateDocumentApi#validate_document_csv_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Validate a Word document (DOCX)
     # Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document
     # @param input_file Input file to perform the operation on.

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

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

data/spec/api/convert_data_api_spec.rb

@@ -37,6 +37,7 @@ describe 'ConvertDataApi' do
   # 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
+  # @option opts [BOOLEAN] :column_names_from_first_row Optional; If true, the first row will be used as the labels for the columns; if false, columns will be named Column0, Column1, etc.  Default is true.  Set to false if you are not using column headings, or have an irregular column structure.
   # @return [Object]
   describe 'convert_data_csv_to_json test' do
     it "should work" do

data/spec/api/validate_document_api_spec.rb

@@ -44,6 +44,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_csv_validation
+  # Validate a CSV file document (CSV)
+  # Validate a CSV file document (CSV); if the document is not valid, identifies the errors in the document
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_csv_validation 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 validate_document_docx_validation
   # Validate a Word document (DOCX)
   # Validate a Word document (DOCX); if the document is not valid, identifies the errors in the document

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-convert-api-client
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.7.6
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus