cloudmersive-convert-api-client 1.5.9 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f61dd567ad35613ad0aa341f97cd2815c36a739778c1b29e28f883d23dc0aea6
-  data.tar.gz: 9a444ff028b884768d6438a7db38f800e73bf2f6c775351122c16a6e2cbe1a12
+  metadata.gz: 5bc136756aa34717f5cf5e54d84e554aec53ee59b88eea57ebb69df436887a10
+  data.tar.gz: be3965f7188826efbd429b9cad94e8a9155c70b8740e3c2cd5a1fc1c3bb57287
 SHA512:
-  metadata.gz: 6a71aab3822ae00814d0a1b2989c4d73616a398a7a988c063eb70c997ca838d02dee6fc0a7a8cbf926ff0b046b896d7759d6a91c15bfa8550a58d1283a48d6d0
-  data.tar.gz: a878fafc82c85e0b5301e0ac63e847dcca73ab785d6306b907f967223c9b66046879853dc3de44e2b2314f450a5ac783f33c39e6db1a80da16d9930157418c45
+  metadata.gz: 3a44e3c4d9679980936502f9c8f61ba1d8aca8be483c6e916099cf08bf3abfa3dee29f7fe1356668f70e44319c27cc95553647b875bd47f8dff3f2e7ad510d7a
+  data.tar.gz: 2835682855bce70a93712ca6c69d67db4bdcd6d6bc72c038734679ef73675c4b07df32d83e67acfec0fe633331bfc90deec383a1c7179ced9e28e62c98efe8b0

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.5.9
+- Package version: 1.6.0
 - 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.5.9.gem
+gem install ./cloudmersive-convert-api-client-1.6.0.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.5.9.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.6.0.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.5.9'
+    gem 'cloudmersive-convert-api-client', '~> 1.6.0'
 
 ### Install from Git
 
@@ -207,6 +207,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_pptx_multi**](docs/MergeDocumentApi.md#merge_document_pptx_multi) | **POST** /convert/merge/pptx/multi | Merge Multple PowerPoint PPTX Together
 *CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx**](docs/MergeDocumentApi.md#merge_document_xlsx) | **POST** /convert/merge/xlsx | Merge Two Excel XLSX Together
 *CloudmersiveConvertApiClient::MergeDocumentApi* | [**merge_document_xlsx_multi**](docs/MergeDocumentApi.md#merge_document_xlsx_multi) | **POST** /convert/merge/xlsx/multi | Merge Multple Excel XLSX Together
+*CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_docx**](docs/SplitDocumentApi.md#split_document_docx) | **POST** /convert/split/docx | Split a single Word Document DOCX into Separate Documents by Page
 *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_pdf_by_page**](docs/SplitDocumentApi.md#split_document_pdf_by_page) | **POST** /convert/split/pdf | Split a PDF file into separate PDF files, one per page
 *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_pptx**](docs/SplitDocumentApi.md#split_document_pptx) | **POST** /convert/split/pptx | Split a single PowerPoint Presentation PPTX into Separate Slides
 *CloudmersiveConvertApiClient::SplitDocumentApi* | [**split_document_xlsx**](docs/SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
@@ -333,6 +334,8 @@ Class | Method | HTTP request | Description
  - [CloudmersiveConvertApiClient::SetFormFieldValue](docs/SetFormFieldValue.md)
  - [CloudmersiveConvertApiClient::SetPdfFormFieldsRequest](docs/SetPdfFormFieldsRequest.md)
  - [CloudmersiveConvertApiClient::SetPdfMetadataRequest](docs/SetPdfMetadataRequest.md)
+ - [CloudmersiveConvertApiClient::SplitDocumentResult](docs/SplitDocumentResult.md)
+ - [CloudmersiveConvertApiClient::SplitDocxDocumentResult](docs/SplitDocxDocumentResult.md)
  - [CloudmersiveConvertApiClient::SplitPdfResult](docs/SplitPdfResult.md)
  - [CloudmersiveConvertApiClient::SplitPptxPresentationResult](docs/SplitPptxPresentationResult.md)
  - [CloudmersiveConvertApiClient::SplitXlsxWorksheetResult](docs/SplitXlsxWorksheetResult.md)

data/docs/SplitDocumentApi.md

@@ -4,11 +4,70 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**split_document_docx**](SplitDocumentApi.md#split_document_docx) | **POST** /convert/split/docx | Split a single Word Document DOCX into Separate Documents by Page
 [**split_document_pdf_by_page**](SplitDocumentApi.md#split_document_pdf_by_page) | **POST** /convert/split/pdf | Split a PDF file into separate PDF files, one per page
 [**split_document_pptx**](SplitDocumentApi.md#split_document_pptx) | **POST** /convert/split/pptx | Split a single PowerPoint Presentation PPTX into Separate Slides
 [**split_document_xlsx**](SplitDocumentApi.md#split_document_xlsx) | **POST** /convert/split/xlsx | Split a single Excel XLSX into Separate Worksheets
 
 
+# **split_document_docx**
+> SplitDocxDocumentResult split_document_docx(input_file, opts)
+
+Split a single Word Document DOCX into Separate Documents by Page
+
+Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
+
+### 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::SplitDocumentApi.new
+
+input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
+
+opts = { 
+  return_document_contents: true # BOOLEAN | Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true.
+}
+
+begin
+  #Split a single Word Document DOCX into Separate Documents by Page
+  result = api_instance.split_document_docx(input_file, opts)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling SplitDocumentApi->split_document_docx: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+ **return_document_contents** | **BOOLEAN**| Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true. | [optional] 
+
+### Return type
+
+[**SplitDocxDocumentResult**](SplitDocxDocumentResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **split_document_pdf_by_page**
 > SplitPdfResult split_document_pdf_by_page(input_file, opts)
 
@@ -91,7 +150,7 @@ api_instance = CloudmersiveConvertApiClient::SplitDocumentApi.new
 input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
 
 opts = { 
-  return_document_contents: true # BOOLEAN | Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true.
+  return_document_contents: true # BOOLEAN | Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true.
 }
 
 begin
@@ -108,7 +167,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **input_file** | **File**| Input file to perform the operation on. | 
- **return_document_contents** | **BOOLEAN**| Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true. | [optional] 
+ **return_document_contents** | **BOOLEAN**| Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true. | [optional] 
 
 ### Return type
 

data/docs/SplitDocumentResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::SplitDocumentResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_number** | **Integer** | Page number of the converted page, starting with 1 for the first page | [optional] 
+**url** | **String** | URL to the DOCX file of this slide; file is stored in an in-memory cache and will be deleted | [optional] 
+**document_contents** | **String** | Contents of the document in bytes | [optional] 
+
+

data/docs/SplitDocxDocumentResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::SplitDocxDocumentResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result_documents** | [**Array<SplitDocumentResult>**](SplitDocumentResult.md) |  | [optional] 
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+
+

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

@@ -127,6 +127,8 @@ 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'
 require 'cloudmersive-convert-api-client/models/set_pdf_metadata_request'
+require 'cloudmersive-convert-api-client/models/split_document_result'
+require 'cloudmersive-convert-api-client/models/split_docx_document_result'
 require 'cloudmersive-convert-api-client/models/split_pdf_result'
 require 'cloudmersive-convert-api-client/models/split_pptx_presentation_result'
 require 'cloudmersive-convert-api-client/models/split_xlsx_worksheet_result'

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

@@ -20,6 +20,65 @@ module CloudmersiveConvertApiClient
       @api_client = api_client
     end
 
+    # Split a single Word Document DOCX into Separate Documents by Page
+    # Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true.
+    # @return [SplitDocxDocumentResult]
+    def split_document_docx(input_file, opts = {})
+      data, _status_code, _headers = split_document_docx_with_http_info(input_file, opts)
+      return data
+    end
+
+    # Split a single Word Document DOCX into Separate Documents by Page
+    # Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true.
+    # @return [Array<(SplitDocxDocumentResult, Fixnum, Hash)>] SplitDocxDocumentResult data, response status code and response headers
+    def split_document_docx_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SplitDocumentApi.split_document_docx ..."
+      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 SplitDocumentApi.split_document_docx"
+      end
+      # resource path
+      local_var_path = "/convert/split/docx"
+
+      # 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[:'returnDocumentContents'] = opts[:'return_document_contents'] if !opts[:'return_document_contents'].nil?
+
+      # 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 => 'SplitDocxDocumentResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SplitDocumentApi#split_document_docx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Split a PDF file into separate PDF files, one per page
     # Split an input PDF file into separate pages, comprised of one PDF file per page.
     # @param input_file Input file to perform the operation on.
@@ -83,7 +142,7 @@ module CloudmersiveConvertApiClient
     # Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true.
+    # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true.
     # @return [SplitPptxPresentationResult]
     def split_document_pptx(input_file, opts = {})
       data, _status_code, _headers = split_document_pptx_with_http_info(input_file, opts)
@@ -94,7 +153,7 @@ module CloudmersiveConvertApiClient
     # Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.
     # @param input_file Input file to perform the operation on.
     # @param [Hash] opts the optional parameters
-    # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true.
+    # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true.
     # @return [Array<(SplitPptxPresentationResult, Fixnum, Hash)>] SplitPptxPresentationResult data, response status code and response headers
     def split_document_pptx_with_http_info(input_file, opts = {})
       if @api_client.config.debugging

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

@@ -0,0 +1,225 @@
+=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
+  # A single Word DOCX file corresponding to one page in the original document
+  class SplitDocumentResult
+    # Page number of the converted page, starting with 1 for the first page
+    attr_accessor :page_number
+
+    # URL to the DOCX file of this slide; file is stored in an in-memory cache and will be deleted
+    attr_accessor :url
+
+    # Contents of the document in bytes
+    attr_accessor :document_contents
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'page_number' => :'PageNumber',
+        :'url' => :'URL',
+        :'document_contents' => :'DocumentContents'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'page_number' => :'Integer',
+        :'url' => :'String',
+        :'document_contents' => :'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?(:'PageNumber')
+        self.page_number = attributes[:'PageNumber']
+      end
+
+      if attributes.has_key?(:'URL')
+        self.url = attributes[:'URL']
+      end
+
+      if attributes.has_key?(:'DocumentContents')
+        self.document_contents = attributes[:'DocumentContents']
+      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 !@document_contents.nil? && @document_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        invalid_properties.push("invalid value for 'document_contents', 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 !@document_contents.nil? && @document_contents !~ 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] document_contents Value to be assigned
+    def document_contents=(document_contents)
+
+      if !document_contents.nil? && document_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        fail ArgumentError, "invalid value for 'document_contents', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
+      end
+
+      @document_contents = document_contents
+    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 &&
+          page_number == o.page_number &&
+          url == o.url &&
+          document_contents == o.document_contents
+    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
+      [page_number, url, document_contents].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

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

@@ -0,0 +1,200 @@
+=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
+  # The result of splitting a Word document into individual Word DOCX pages
+  class SplitDocxDocumentResult
+    attr_accessor :result_documents
+
+    # True if the operation was successful, false otherwise
+    attr_accessor :successful
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'result_documents' => :'ResultDocuments',
+        :'successful' => :'Successful'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'result_documents' => :'Array<SplitDocumentResult>',
+        :'successful' => :'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?(:'ResultDocuments')
+        if (value = attributes[:'ResultDocuments']).is_a?(Array)
+          self.result_documents = value
+        end
+      end
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      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
+      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 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 &&
+          result_documents == o.result_documents &&
+          successful == o.successful
+    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
+      [result_documents, successful].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

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

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

data/spec/api/split_document_api_spec.rb

@@ -32,6 +32,19 @@ describe 'SplitDocumentApi' do
     end
   end
 
+  # unit tests for split_document_docx
+  # Split a single Word Document DOCX into Separate Documents by Page
+  # Split a Word DOCX Document, comprised of multiple pages into separate Word DOCX document files, with each containing exactly one page.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting document.  Default is true.
+  # @return [SplitDocxDocumentResult]
+  describe 'split_document_docx 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 split_document_pdf_by_page
   # Split a PDF file into separate PDF files, one per page
   # Split an input PDF file into separate pages, comprised of one PDF file per page.
@@ -50,7 +63,7 @@ describe 'SplitDocumentApi' do
   # Split an PowerPoint PPTX Presentation, comprised of multiple slides into separate PowerPoint PPTX presentation files, with each containing exactly one slide.
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
-  # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each Worksheet directly, set to false to only return URLs to each resulting worksheet.  Default is true.
+  # @option opts [BOOLEAN] :return_document_contents Set to true to return the contents of each presentation directly, set to false to only return URLs to each resulting presentation.  Default is true.
   # @return [SplitPptxPresentationResult]
   describe 'split_document_pptx test' do
     it "should work" do

data/spec/models/split_document_result_spec.rb

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

data/spec/models/split_docx_document_result_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-convert-api-client
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.0
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -322,6 +322,8 @@ files:
 - "./docs/SetPdfFormFieldsRequest.md"
 - "./docs/SetPdfMetadataRequest.md"
 - "./docs/SplitDocumentApi.md"
+- "./docs/SplitDocumentResult.md"
+- "./docs/SplitDocxDocumentResult.md"
 - "./docs/SplitPdfResult.md"
 - "./docs/SplitPptxPresentationResult.md"
 - "./docs/SplitXlsxWorksheetResult.md"
@@ -477,6 +479,8 @@ files:
 - "./lib/cloudmersive-convert-api-client/models/set_form_field_value.rb"
 - "./lib/cloudmersive-convert-api-client/models/set_pdf_form_fields_request.rb"
 - "./lib/cloudmersive-convert-api-client/models/set_pdf_metadata_request.rb"
+- "./lib/cloudmersive-convert-api-client/models/split_document_result.rb"
+- "./lib/cloudmersive-convert-api-client/models/split_docx_document_result.rb"
 - "./lib/cloudmersive-convert-api-client/models/split_pdf_result.rb"
 - "./lib/cloudmersive-convert-api-client/models/split_pptx_presentation_result.rb"
 - "./lib/cloudmersive-convert-api-client/models/split_xlsx_worksheet_result.rb"
@@ -628,6 +632,8 @@ files:
 - "./spec/models/set_form_field_value_spec.rb"
 - "./spec/models/set_pdf_form_fields_request_spec.rb"
 - "./spec/models/set_pdf_metadata_request_spec.rb"
+- "./spec/models/split_document_result_spec.rb"
+- "./spec/models/split_docx_document_result_spec.rb"
 - "./spec/models/split_pdf_result_spec.rb"
 - "./spec/models/split_pptx_presentation_result_spec.rb"
 - "./spec/models/split_xlsx_worksheet_result_spec.rb"