cloudmersive-convert-api-client 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca5ad2e3a95f3a2973cdc4d7ad86d4974407b81ec1b83d20f9a0cfd9f823024f
-  data.tar.gz: adac2475d8aa68688101397d485f8a1909000a2de990cd692cdda723bc62a8f4
+  metadata.gz: e039f137f65a46bf9bf724b775e5c7e44da26c3a54c9029c3a06ec5234401ad3
+  data.tar.gz: 23268f6b96ccfd0ad5e5cb337328fa05db3089196bca5e3389a23e2d34472b32
 SHA512:
-  metadata.gz: 8dd983dd6fa1339c6b617d01ce19376328984b0fd441b74e93f5a91dcdcbd81c7df8f408e1a296597418ee3acbdb5c9ae96ee45e408615aeb86863cb3b5879a2
-  data.tar.gz: b3273a40e981be1849219a87a94b3343e7208f1b1f5a88c13d91a6a4442e640d6668f69eeb96e0f6b5a3eec72892064daebd2c759cc7c1f057af28284eee9c72
+  metadata.gz: e08309024dd891b418d7731f82e2a11b5a1b385699865fbc871007cdb5cee257b04d6f2ef4748458797c98728734fb67d529ae4a3d73ff2e392457f17183a84b
+  data.tar.gz: 283f31636fdeaa78c28b1b8df9226af6a33fb00269a2ea1c701f546ebfc9aeceb3cc7cc6032400b590ffde88caea01d92b67a6e1e29cdd8e6ae2beef4861539c

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: 2.1.2
+- Package version: 2.1.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-2.1.2.gem
+gem install ./cloudmersive-convert-api-client-2.1.3.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-convert-api-client-2.1.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', '~> 2.1.2'
+    gem 'cloudmersive-convert-api-client', '~> 2.1.3'
 
 ### Install from Git
 
@@ -210,6 +210,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_comments_hierarchical**](docs/EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_headers_and_footers**](docs/EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_images**](docs/EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
+*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_metadata_properties**](docs/EditDocumentApi.md#edit_document_docx_get_metadata_properties) | **POST** /convert/edit/docx/get-metadata | Get all metadata properties in Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_sections**](docs/EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_styles**](docs/EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_get_table_by_index**](docs/EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
@@ -227,6 +228,7 @@ Class | Method | HTTP request | Description
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace**](docs/EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_multi**](docs/EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_replace_paragraph**](docs/EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
+*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_custom_metadata_properties**](docs/EditDocumentApi.md#edit_document_docx_set_custom_metadata_properties) | **POST** /convert/edit/docx/set-metadata/custom-property | Set custom property metadata properties in Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer**](docs/EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_footer_add_page_number**](docs/EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
 *CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_docx_set_header**](docs/EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
@@ -393,12 +395,14 @@ Class | Method | HTTP request | Description
  - [CloudmersiveConvertApiClient::DocxInsertCommentOnParagraphRequest](docs/DocxInsertCommentOnParagraphRequest.md)
  - [CloudmersiveConvertApiClient::DocxInsertImageRequest](docs/DocxInsertImageRequest.md)
  - [CloudmersiveConvertApiClient::DocxInsertImageResponse](docs/DocxInsertImageResponse.md)
+ - [CloudmersiveConvertApiClient::DocxMetadataCustomProperty](docs/DocxMetadataCustomProperty.md)
  - [CloudmersiveConvertApiClient::DocxPage](docs/DocxPage.md)
  - [CloudmersiveConvertApiClient::DocxParagraph](docs/DocxParagraph.md)
  - [CloudmersiveConvertApiClient::DocxRemoveObjectRequest](docs/DocxRemoveObjectRequest.md)
  - [CloudmersiveConvertApiClient::DocxRemoveObjectResponse](docs/DocxRemoveObjectResponse.md)
  - [CloudmersiveConvertApiClient::DocxRun](docs/DocxRun.md)
  - [CloudmersiveConvertApiClient::DocxSection](docs/DocxSection.md)
+ - [CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest](docs/DocxSetCustomMetadataPropertiesRequest.md)
  - [CloudmersiveConvertApiClient::DocxSetFooterAddPageNumberRequest](docs/DocxSetFooterAddPageNumberRequest.md)
  - [CloudmersiveConvertApiClient::DocxSetFooterRequest](docs/DocxSetFooterRequest.md)
  - [CloudmersiveConvertApiClient::DocxSetFooterResponse](docs/DocxSetFooterResponse.md)
@@ -440,6 +444,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveConvertApiClient::GetDocxHeadersAndFootersResponse](docs/GetDocxHeadersAndFootersResponse.md)
  - [CloudmersiveConvertApiClient::GetDocxImagesRequest](docs/GetDocxImagesRequest.md)
  - [CloudmersiveConvertApiClient::GetDocxImagesResponse](docs/GetDocxImagesResponse.md)
+ - [CloudmersiveConvertApiClient::GetDocxMetadataPropertiesResponse](docs/GetDocxMetadataPropertiesResponse.md)
  - [CloudmersiveConvertApiClient::GetDocxPagesRequest](docs/GetDocxPagesRequest.md)
  - [CloudmersiveConvertApiClient::GetDocxPagesResponse](docs/GetDocxPagesResponse.md)
  - [CloudmersiveConvertApiClient::GetDocxSectionsRequest](docs/GetDocxSectionsRequest.md)

data/docs/DocxMetadataCustomProperty.md

@@ -0,0 +1,13 @@
+# CloudmersiveConvertApiClient::DocxMetadataCustomProperty
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property_name** | **String** | Name of the property | [optional] 
+**property_data_type** | **String** | Data type of the property; possible values are \"string\", \"integer\", \"double\" or \"date\" | [optional] 
+**string_value** | **String** | If the property is of a string data type, then provides the string value if available | [optional] 
+**integer_value** | **Integer** | If the property is of a integer data type, then provides the integer value if available | [optional] 
+**double_value** | **Float** | If the property is of a double floating point data type, then provides the double value if available | [optional] 
+**date_value** | **DateTime** | If the property is of a date time data type, then provides the date time value if available | [optional] 
+
+

data/docs/DocxSetCustomMetadataPropertiesRequest.md

@@ -0,0 +1,10 @@
+# CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file_bytes** | **String** | Optional: Bytes of the input file to operate on | [optional] 
+**input_file_url** | **String** | 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 to upload a document and pass in the secure URL result from that operation as the URL here (this URL is not public). | [optional] 
+**properties_to_set** | [**Array<DocxMetadataCustomProperty>**](DocxMetadataCustomProperty.md) | Required: properties to set in the Word Document; provide one or more property definitions to set - be sure to specify the data type and value, together with the property name | [optional] 
+
+

data/docs/EditDocumentApi.md

@@ -18,6 +18,7 @@ Method | HTTP request | Description
 [**edit_document_docx_get_comments_hierarchical**](EditDocumentApi.md#edit_document_docx_get_comments_hierarchical) | **POST** /convert/edit/docx/get-comments/hierarchical | Get comments from a Word DOCX document hierarchically
 [**edit_document_docx_get_headers_and_footers**](EditDocumentApi.md#edit_document_docx_get_headers_and_footers) | **POST** /convert/edit/docx/get-headers-and-footers | Get content of a footer from a Word DOCX document
 [**edit_document_docx_get_images**](EditDocumentApi.md#edit_document_docx_get_images) | **POST** /convert/edit/docx/get-images | Get images from a Word DOCX document
+[**edit_document_docx_get_metadata_properties**](EditDocumentApi.md#edit_document_docx_get_metadata_properties) | **POST** /convert/edit/docx/get-metadata | Get all metadata properties in Word DOCX document
 [**edit_document_docx_get_sections**](EditDocumentApi.md#edit_document_docx_get_sections) | **POST** /convert/edit/docx/get-sections | Get sections from a Word DOCX document
 [**edit_document_docx_get_styles**](EditDocumentApi.md#edit_document_docx_get_styles) | **POST** /convert/edit/docx/get-styles | Get styles from a Word DOCX document
 [**edit_document_docx_get_table_by_index**](EditDocumentApi.md#edit_document_docx_get_table_by_index) | **POST** /convert/edit/docx/get-table/by-index | Get a specific table by index in a Word DOCX document
@@ -35,6 +36,7 @@ Method | HTTP request | Description
 [**edit_document_docx_replace**](EditDocumentApi.md#edit_document_docx_replace) | **POST** /convert/edit/docx/replace-all | Replace string in Word DOCX document
 [**edit_document_docx_replace_multi**](EditDocumentApi.md#edit_document_docx_replace_multi) | **POST** /convert/edit/docx/replace-all/multi | Replace multiple strings in Word DOCX document
 [**edit_document_docx_replace_paragraph**](EditDocumentApi.md#edit_document_docx_replace_paragraph) | **POST** /convert/edit/docx/replace/paragraph | Replace matching paragraphs in a Word DOCX document
+[**edit_document_docx_set_custom_metadata_properties**](EditDocumentApi.md#edit_document_docx_set_custom_metadata_properties) | **POST** /convert/edit/docx/set-metadata/custom-property | Set custom property metadata properties in Word DOCX document
 [**edit_document_docx_set_footer**](EditDocumentApi.md#edit_document_docx_set_footer) | **POST** /convert/edit/docx/set-footer | Set the footer in a Word DOCX document
 [**edit_document_docx_set_footer_add_page_number**](EditDocumentApi.md#edit_document_docx_set_footer_add_page_number) | **POST** /convert/edit/docx/set-footer/add-page-number | Add page number to footer in a Word DOCX document
 [**edit_document_docx_set_header**](EditDocumentApi.md#edit_document_docx_set_header) | **POST** /convert/edit/docx/set-header | Set the header in a Word DOCX document
@@ -821,6 +823,60 @@ Name | Type | Description  | Notes
 
 
 
+# **edit_document_docx_get_metadata_properties**
+> GetDocxMetadataPropertiesResponse edit_document_docx_get_metadata_properties(input_file)
+
+Get all metadata properties in Word DOCX document
+
+Returns all the metadata properties in an Office Word Document (docx)
+
+### 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::EditDocumentApi.new
+
+input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
+
+
+begin
+  #Get all metadata properties in Word DOCX document
+  result = api_instance.edit_document_docx_get_metadata_properties(input_file)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditDocumentApi->edit_document_docx_get_metadata_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on. | 
+
+### Return type
+
+[**GetDocxMetadataPropertiesResponse**](GetDocxMetadataPropertiesResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **edit_document_docx_get_sections**
 > GetDocxSectionsResponse edit_document_docx_get_sections(req_config)
 
@@ -1739,6 +1795,60 @@ Name | Type | Description  | Notes
 
 
 
+# **edit_document_docx_set_custom_metadata_properties**
+> String edit_document_docx_set_custom_metadata_properties(input)
+
+Set custom property metadata properties in Word DOCX document
+
+Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
+
+### 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::EditDocumentApi.new
+
+input = CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest.new # DocxSetCustomMetadataPropertiesRequest | 
+
+
+begin
+  #Set custom property metadata properties in Word DOCX document
+  result = api_instance.edit_document_docx_set_custom_metadata_properties(input)
+  p result
+rescue CloudmersiveConvertApiClient::ApiError => e
+  puts "Exception when calling EditDocumentApi->edit_document_docx_set_custom_metadata_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DocxSetCustomMetadataPropertiesRequest**](DocxSetCustomMetadataPropertiesRequest.md)|  | 
+
+### Return type
+
+**String**
+
+### 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/json, text/json, application/xml, text/xml
+
+
+
 # **edit_document_docx_set_footer**
 > DocxSetFooterResponse edit_document_docx_set_footer(req_config)
 

data/docs/GetDocxMetadataPropertiesResponse.md

@@ -0,0 +1,16 @@
+# CloudmersiveConvertApiClient::GetDocxMetadataPropertiesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company** | **String** | Name of the Company that authored the document, if available | [optional] 
+**manager** | **String** | Name of the Manager that authored the document, if available | [optional] 
+**application_version** | **String** | Application version that authored the document, if available | [optional] 
+**word_count** | **Integer** | Word count of the document | [optional] 
+**line_count** | **Integer** | Line count of the document | [optional] 
+**paragraph_count** | **Integer** | Paragraph count of the document | [optional] 
+**page_count** | **Integer** | Page count of the document | [optional] 
+**custom_properties** | [**Array<DocxMetadataCustomProperty>**](DocxMetadataCustomProperty.md) | Custom properties applied to the document | [optional] 
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+
+

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

@@ -66,12 +66,14 @@ require 'cloudmersive-convert-api-client/models/docx_image'
 require 'cloudmersive-convert-api-client/models/docx_insert_comment_on_paragraph_request'
 require 'cloudmersive-convert-api-client/models/docx_insert_image_request'
 require 'cloudmersive-convert-api-client/models/docx_insert_image_response'
+require 'cloudmersive-convert-api-client/models/docx_metadata_custom_property'
 require 'cloudmersive-convert-api-client/models/docx_page'
 require 'cloudmersive-convert-api-client/models/docx_paragraph'
 require 'cloudmersive-convert-api-client/models/docx_remove_object_request'
 require 'cloudmersive-convert-api-client/models/docx_remove_object_response'
 require 'cloudmersive-convert-api-client/models/docx_run'
 require 'cloudmersive-convert-api-client/models/docx_section'
+require 'cloudmersive-convert-api-client/models/docx_set_custom_metadata_properties_request'
 require 'cloudmersive-convert-api-client/models/docx_set_footer_add_page_number_request'
 require 'cloudmersive-convert-api-client/models/docx_set_footer_request'
 require 'cloudmersive-convert-api-client/models/docx_set_footer_response'
@@ -113,6 +115,7 @@ require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_req
 require 'cloudmersive-convert-api-client/models/get_docx_headers_and_footers_response'
 require 'cloudmersive-convert-api-client/models/get_docx_images_request'
 require 'cloudmersive-convert-api-client/models/get_docx_images_response'
+require 'cloudmersive-convert-api-client/models/get_docx_metadata_properties_response'
 require 'cloudmersive-convert-api-client/models/get_docx_pages_request'
 require 'cloudmersive-convert-api-client/models/get_docx_pages_response'
 require 'cloudmersive-convert-api-client/models/get_docx_sections_request'

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

@@ -779,6 +779,61 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Get all metadata properties in Word DOCX document
+    # Returns all the metadata properties in an Office Word Document (docx)
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [GetDocxMetadataPropertiesResponse]
+    def edit_document_docx_get_metadata_properties(input_file, opts = {})
+      data, _status_code, _headers = edit_document_docx_get_metadata_properties_with_http_info(input_file, opts)
+      data
+    end
+
+    # Get all metadata properties in Word DOCX document
+    # Returns all the metadata properties in an Office Word Document (docx)
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDocxMetadataPropertiesResponse, Fixnum, Hash)>] GetDocxMetadataPropertiesResponse data, response status code and response headers
+    def edit_document_docx_get_metadata_properties_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_get_metadata_properties ...'
+      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 EditDocumentApi.edit_document_docx_get_metadata_properties"
+      end
+      # resource path
+      local_var_path = '/convert/edit/docx/get-metadata'
+
+      # 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 => 'GetDocxMetadataPropertiesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_metadata_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get sections from a Word DOCX document
     # Returns the sections defined in the Word Document (DOCX) format file
     # @param req_config Document input request
@@ -1698,6 +1753,60 @@ module CloudmersiveConvertApiClient
       end
       return data, status_code, headers
     end
+    # Set custom property metadata properties in Word DOCX document
+    # Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
+    # @param input 
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def edit_document_docx_set_custom_metadata_properties(input, opts = {})
+      data, _status_code, _headers = edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts)
+      data
+    end
+
+    # Set custom property metadata properties in Word DOCX document
+    # Sets the custom property metadata for the metadata properties in an Office Word Document (docx)
+    # @param input 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def edit_document_docx_set_custom_metadata_properties_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EditDocumentApi.edit_document_docx_set_custom_metadata_properties ...'
+      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 EditDocumentApi.edit_document_docx_set_custom_metadata_properties"
+      end
+      # resource path
+      local_var_path = '/convert/edit/docx/set-metadata/custom-property'
+
+      # 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(['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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_set_custom_metadata_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Set the footer in a Word DOCX document
     # Set the footer in a Word Document (DOCX).  Call Finish Editing on the output URL to complete the operation.
     # @param req_config Document input request

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

@@ -0,0 +1,236 @@
+=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
+  # Name and value pair for a custom-defined DOCX metadata property
+  class DocxMetadataCustomProperty
+    # Name of the property
+    attr_accessor :property_name
+
+    # Data type of the property; possible values are \"string\", \"integer\", \"double\" or \"date\"
+    attr_accessor :property_data_type
+
+    # If the property is of a string data type, then provides the string value if available
+    attr_accessor :string_value
+
+    # If the property is of a integer data type, then provides the integer value if available
+    attr_accessor :integer_value
+
+    # If the property is of a double floating point data type, then provides the double value if available
+    attr_accessor :double_value
+
+    # If the property is of a date time data type, then provides the date time value if available
+    attr_accessor :date_value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'property_name' => :'PropertyName',
+        :'property_data_type' => :'PropertyDataType',
+        :'string_value' => :'StringValue',
+        :'integer_value' => :'IntegerValue',
+        :'double_value' => :'DoubleValue',
+        :'date_value' => :'DateValue'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'property_name' => :'String',
+        :'property_data_type' => :'String',
+        :'string_value' => :'String',
+        :'integer_value' => :'Integer',
+        :'double_value' => :'Float',
+        :'date_value' => :'DateTime'
+      }
+    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?(:'PropertyName')
+        self.property_name = attributes[:'PropertyName']
+      end
+
+      if attributes.has_key?(:'PropertyDataType')
+        self.property_data_type = attributes[:'PropertyDataType']
+      end
+
+      if attributes.has_key?(:'StringValue')
+        self.string_value = attributes[:'StringValue']
+      end
+
+      if attributes.has_key?(:'IntegerValue')
+        self.integer_value = attributes[:'IntegerValue']
+      end
+
+      if attributes.has_key?(:'DoubleValue')
+        self.double_value = attributes[:'DoubleValue']
+      end
+
+      if attributes.has_key?(:'DateValue')
+        self.date_value = attributes[:'DateValue']
+      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 &&
+          property_name == o.property_name &&
+          property_data_type == o.property_data_type &&
+          string_value == o.string_value &&
+          integer_value == o.integer_value &&
+          double_value == o.double_value &&
+          date_value == o.date_value
+    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
+      [property_name, property_data_type, string_value, integer_value, double_value, date_value].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