cloudmersive-convert-api-client 1.6.7 → 1.6.8

data/docs/FindRegexMatch.md

@@ -0,0 +1,12 @@
+# CloudmersiveConvertApiClient::FindRegexMatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**character_offset_start** | **Integer** | 0-based index of the start of the match | [optional] 
+**character_offset_end** | **Integer** | 0-based index of the end of the match | [optional] 
+**containing_line** | **String** | Text content of the line containing the match | [optional] 
+**match_value** | **String** | The match value | [optional] 
+**match_groups** | **Array<String>** | Regular expression regex match groups; these correspond to the match values | [optional] 
+
+

data/docs/FindStringMatch.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringMatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**character_offset_start** | **Integer** | 0-based index of the start of the match | [optional] 
+**character_offset_end** | **Integer** | 0-based index of the end of the match | [optional] 
+**containing_line** | **String** | Text content of the line containing the match | [optional] 
+
+

data/docs/FindStringRegexRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringRegexRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**target_regex** | **String** | Target input regular expression (regex) to find | [optional] 
+**match_case** | **BOOLEAN** | Set to True to match case, False to ignore case | [optional] 
+
+

data/docs/FindStringRegexResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringRegexResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**matches** | [**Array<FindRegexMatch>**](FindRegexMatch.md) | Regular expression matches | [optional] 
+**match_count** | **Integer** | The number of matches | [optional] 
+
+

data/docs/FindStringSimpleRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::FindStringSimpleRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**target_string** | **String** | Target input string to find | [optional] 
+
+

data/docs/FindStringSimpleResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::FindStringSimpleResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**matches** | [**Array<FindStringMatch>**](FindStringMatch.md) | Found matches | [optional] 
+**match_count** | **Integer** | The number of matches | [optional] 
+
+

data/docs/ReplaceStringRegexRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::ReplaceStringRegexRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**regular_expression_string** | **String** | Target input regular expression (regex) string to match and be replaced; supports all regular expression values | [optional] 
+**replace_with_string** | **String** | Replacement for target string; supports referencing indexed regex matched values from RegularExpressionString, such as $1, $2, and so on | [optional] 
+
+

data/docs/ReplaceStringRegexResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::ReplaceStringRegexResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**text_content_result** | **String** | Result of performing a base 64 decode operation, binary file content | [optional] 
+
+

data/docs/ReplaceStringSimpleRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::ReplaceStringSimpleRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text_content** | **String** | Input text content | [optional] 
+**target_string** | **String** | Target input string to match and be replaced | [optional] 
+**replace_with_string** | **String** | Replacement for target string | [optional] 
+
+

data/docs/ReplaceStringSimpleResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::ReplaceStringSimpleResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**text_content_result** | **String** | Result of performing a replace string operation | [optional] 
+
+

data/docs/ZipArchiveApi.md

@@ -0,0 +1,167 @@
+# CloudmersiveConvertApiClient::ZipArchiveApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**zip_archive_zip_create**](ZipArchiveApi.md#zip_archive_zip_create) | **POST** /convert/archive/zip/create | Compress files to create a new zip archive
+[**zip_archive_zip_create_advanced**](ZipArchiveApi.md#zip_archive_zip_create_advanced) | **POST** /convert/archive/zip/create/advanced | Compress files and folders to create a new zip archive with advanced options
+[**zip_archive_zip_extract**](ZipArchiveApi.md#zip_archive_zip_extract) | **POST** /convert/archive/zip/extract | Extract, decompress files and folders from a zip archive
+
+
+# **zip_archive_zip_create**
+> Object zip_archive_zip_create
+
+Compress files to create a new zip archive
+
+Create a new zip archive by compressing input files.
+
+### 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::ZipArchiveApi.new
+
+begin
+  #Compress files to create a new zip archive
+  result = api_instance.zip_archive_zip_create
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ZipArchiveApi->zip_archive_zip_create: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream
+
+
+
+# **zip_archive_zip_create_advanced**
+> Object zip_archive_zip_create_advanced(request)
+
+Compress files and folders to create a new zip archive with advanced options
+
+Create a new zip archive by compressing input files, folders and leverage advanced options to control the structure of the resulting zip archive.
+
+### 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::ZipArchiveApi.new
+
+request = CloudmersiveConvertApiClient::CreateZipArchiveRequest.new # CreateZipArchiveRequest | Input request
+
+
+begin
+  #Compress files and folders to create a new zip archive with advanced options
+  result = api_instance.zip_archive_zip_create_advanced(request)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ZipArchiveApi->zip_archive_zip_create_advanced: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request** | [**CreateZipArchiveRequest**](CreateZipArchiveRequest.md)| Input request | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
+ - **Accept**: application/octet-stream
+
+
+
+# **zip_archive_zip_extract**
+> ZipExtractResponse zip_archive_zip_extract(input_file)
+
+Extract, decompress files and folders from a zip archive
+
+Extracts a zip archive by decompressing files, and folders.
+
+### 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::ZipArchiveApi.new
+
+input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
+
+
+begin
+  #Extract, decompress files and folders from a zip archive
+  result = api_instance.zip_archive_zip_extract(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling ZipArchiveApi->zip_archive_zip_extract: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+
+### Return type
+
+[**ZipExtractResponse**](ZipExtractResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/ZipDirectory.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::ZipDirectory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**directory_name** | **String** | Name of this directory | [optional] 
+**directories_in_directory** | [**Array<ZipDirectory>**](ZipDirectory.md) | Child directories contained directly in this directory | [optional] 
+**files_in_directory** | [**Array<ZipFile>**](ZipFile.md) | Child files contained directly in this directory | [optional] 
+
+

data/docs/ZipExtractResponse.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::ZipExtractResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**files_in_zip** | [**Array<ZipFile>**](ZipFile.md) | Top-level files in the root directory fo the zip file | [optional] 
+**directories_in_zip** | [**Array<ZipDirectory>**](ZipDirectory.md) | Top-level directories in the root directory of the zip; directories can contain sub-directories and files | [optional] 
+
+

data/docs/ZipFile.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::ZipFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_name** | **String** | Name of this file | [optional] 
+**file_contents** | **String** | Contents of this file | [optional] 
+
+

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

@@ -38,6 +38,7 @@ require 'cloudmersive-convert-api-client/models/create_blank_spreadsheet_request
 require 'cloudmersive-convert-api-client/models/create_blank_spreadsheet_response'
 require 'cloudmersive-convert-api-client/models/create_spreadsheet_from_data_request'
 require 'cloudmersive-convert-api-client/models/create_spreadsheet_from_data_response'
+require 'cloudmersive-convert-api-client/models/create_zip_archive_request'
 require 'cloudmersive-convert-api-client/models/delete_docx_table_row_range_request'
 require 'cloudmersive-convert-api-client/models/delete_docx_table_row_range_response'
 require 'cloudmersive-convert-api-client/models/delete_docx_table_row_request'
@@ -74,6 +75,12 @@ require 'cloudmersive-convert-api-client/models/docx_template_operation'
 require 'cloudmersive-convert-api-client/models/docx_text'
 require 'cloudmersive-convert-api-client/models/docx_top_level_comment'
 require 'cloudmersive-convert-api-client/models/exif_value'
+require 'cloudmersive-convert-api-client/models/find_regex_match'
+require 'cloudmersive-convert-api-client/models/find_string_match'
+require 'cloudmersive-convert-api-client/models/find_string_regex_request'
+require 'cloudmersive-convert-api-client/models/find_string_regex_response'
+require 'cloudmersive-convert-api-client/models/find_string_simple_request'
+require 'cloudmersive-convert-api-client/models/find_string_simple_response'
 require 'cloudmersive-convert-api-client/models/finish_editing_request'
 require 'cloudmersive-convert-api-client/models/get_docx_body_request'
 require 'cloudmersive-convert-api-client/models/get_docx_body_response'
@@ -151,7 +158,11 @@ require 'cloudmersive-convert-api-client/models/remove_pptx_slides_request'
 require 'cloudmersive-convert-api-client/models/remove_whitespace_from_text_request'
 require 'cloudmersive-convert-api-client/models/remove_whitespace_from_text_response'
 require 'cloudmersive-convert-api-client/models/remove_xlsx_worksheet_request'
+require 'cloudmersive-convert-api-client/models/replace_string_regex_request'
+require 'cloudmersive-convert-api-client/models/replace_string_regex_response'
 require 'cloudmersive-convert-api-client/models/replace_string_request'
+require 'cloudmersive-convert-api-client/models/replace_string_simple_request'
+require 'cloudmersive-convert-api-client/models/replace_string_simple_response'
 require 'cloudmersive-convert-api-client/models/screenshot_request'
 require 'cloudmersive-convert-api-client/models/set_form_field_value'
 require 'cloudmersive-convert-api-client/models/set_pdf_form_fields_request'
@@ -193,6 +204,9 @@ require 'cloudmersive-convert-api-client/models/xml_remove_all_children_with_x_p
 require 'cloudmersive-convert-api-client/models/xml_remove_with_x_path_result'
 require 'cloudmersive-convert-api-client/models/xml_replace_with_x_path_result'
 require 'cloudmersive-convert-api-client/models/xml_set_value_with_x_path_result'
+require 'cloudmersive-convert-api-client/models/zip_directory'
+require 'cloudmersive-convert-api-client/models/zip_extract_response'
+require 'cloudmersive-convert-api-client/models/zip_file'
 
 # APIs
 require 'cloudmersive-convert-api-client/api/compare_document_api'
@@ -208,6 +222,7 @@ require 'cloudmersive-convert-api-client/api/merge_document_api'
 require 'cloudmersive-convert-api-client/api/split_document_api'
 require 'cloudmersive-convert-api-client/api/validate_document_api'
 require 'cloudmersive-convert-api-client/api/viewer_tools_api'
+require 'cloudmersive-convert-api-client/api/zip_archive_api'
 
 module CloudmersiveConvertApiClient
   class << self

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

@@ -78,7 +78,7 @@ module CloudmersiveConvertApiClient
 
     # Convert JSON to XML conversion
     # Convert a JSON object into XML
-    # @param json_object 
+    # @param json_object Input JSON to convert to XML
     # @param [Hash] opts the optional parameters
     # @return [String]
     def convert_data_json_to_xml(json_object, opts = {})
@@ -88,7 +88,7 @@ module CloudmersiveConvertApiClient
 
     # Convert JSON to XML conversion
     # Convert a JSON object into XML
-    # @param json_object 
+    # @param json_object Input JSON to convert to XML
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def convert_data_json_to_xml_with_http_info(json_object, opts = {})

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

@@ -185,68 +185,13 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
-    # Convert website URL page to text (txt)
-    # Converts a website URL page into text (txt); extracts text from HTML
-    # @param input HTML to Text request parameters
-    # @param [Hash] opts the optional parameters
-    # @return [UrlToTextResponse]
-    def convert_web_html_to_txt(input, opts = {})
-      data, _status_code, _headers = convert_web_html_to_txt_with_http_info(input, opts)
-      return data
-    end
-
-    # Convert website URL page to text (txt)
-    # Converts a website URL page into text (txt); extracts text from HTML
-    # @param input HTML to Text request parameters
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(UrlToTextResponse, Fixnum, Hash)>] UrlToTextResponse data, response status code and response headers
-    def convert_web_html_to_txt_with_http_info(input, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ConvertWebApi.convert_web_html_to_txt ..."
-      end
-      # verify the required parameter 'input' is set
-      if @api_client.config.client_side_validation && input.nil?
-        fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_html_to_txt"
-      end
-      # resource path
-      local_var_path = "/convert/web/url/to/txt"
-
-      # 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(['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(input)
-      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 => 'UrlToTextResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Convert HTML string to text (txt)
     # Converts an HTML string input into text (txt); extracts text from HTML
     # @param input HTML to Text request parameters
     # @param [Hash] opts the optional parameters
     # @return [HtmlToTextResponse]
-    def convert_web_html_to_txt_0(input, opts = {})
-      data, _status_code, _headers = convert_web_html_to_txt_0_with_http_info(input, opts)
+    def convert_web_html_to_txt(input, opts = {})
+      data, _status_code, _headers = convert_web_html_to_txt_with_http_info(input, opts)
       return data
     end
 
@@ -255,13 +200,13 @@ module CloudmersiveConvertApiClient
     # @param input HTML to Text request parameters
     # @param [Hash] opts the optional parameters
     # @return [Array<(HtmlToTextResponse, Fixnum, Hash)>] HtmlToTextResponse data, response status code and response headers
-    def convert_web_html_to_txt_0_with_http_info(input, opts = {})
+    def convert_web_html_to_txt_with_http_info(input, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ConvertWebApi.convert_web_html_to_txt_0 ..."
+        @api_client.config.logger.debug "Calling API: ConvertWebApi.convert_web_html_to_txt ..."
       end
       # verify the required parameter 'input' is set
       if @api_client.config.client_side_validation && input.nil?
-        fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_html_to_txt_0"
+        fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_html_to_txt"
       end
       # resource path
       local_var_path = "/convert/web/html/to/txt"
@@ -290,7 +235,7 @@ module CloudmersiveConvertApiClient
         :auth_names => auth_names,
         :return_type => 'HtmlToTextResponse')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_txt_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_html_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -460,5 +405,60 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+
+    # Convert website URL page to text (txt)
+    # Converts a website URL page into text (txt); extracts text from HTML
+    # @param input HTML to Text request parameters
+    # @param [Hash] opts the optional parameters
+    # @return [UrlToTextResponse]
+    def convert_web_url_to_txt(input, opts = {})
+      data, _status_code, _headers = convert_web_url_to_txt_with_http_info(input, opts)
+      return data
+    end
+
+    # Convert website URL page to text (txt)
+    # Converts a website URL page into text (txt); extracts text from HTML
+    # @param input HTML to Text request parameters
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UrlToTextResponse, Fixnum, Hash)>] UrlToTextResponse data, response status code and response headers
+    def convert_web_url_to_txt_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ConvertWebApi.convert_web_url_to_txt ..."
+      end
+      # verify the required parameter 'input' is set
+      if @api_client.config.client_side_validation && input.nil?
+        fail ArgumentError, "Missing the required parameter 'input' when calling ConvertWebApi.convert_web_url_to_txt"
+      end
+      # resource path
+      local_var_path = "/convert/web/url/to/txt"
+
+      # 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(['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(input)
+      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 => 'UrlToTextResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConvertWebApi#convert_web_url_to_txt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end