cloudmersive-convert-api-client 1.5.2 → 1.5.3

data/docs/UpdateDocxTableRowResponse.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::UpdateDocxTableRowResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**edited_document_url** | **String** | URL to the edited DOCX file; file is stored in an in-memory cache and will be deleted.  Call Finish-Editing to get the result document contents. | [optional] 
+
+

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

@@ -22,6 +22,8 @@ require 'cloudmersive-convert-api-client/models/autodetect_document_validation_r
 require 'cloudmersive-convert-api-client/models/autodetect_get_info_result'
 require 'cloudmersive-convert-api-client/models/autodetect_to_png_result'
 require 'cloudmersive-convert-api-client/models/converted_png_page'
+require 'cloudmersive-convert-api-client/models/delete_docx_table_row_request'
+require 'cloudmersive-convert-api-client/models/delete_docx_table_row_response'
 require 'cloudmersive-convert-api-client/models/document_validation_error'
 require 'cloudmersive-convert-api-client/models/document_validation_result'
 require 'cloudmersive-convert-api-client/models/docx_body'
@@ -63,6 +65,10 @@ require 'cloudmersive-convert-api-client/models/get_docx_sections_request'
 require 'cloudmersive-convert-api-client/models/get_docx_sections_response'
 require 'cloudmersive-convert-api-client/models/get_docx_styles_request'
 require 'cloudmersive-convert-api-client/models/get_docx_styles_response'
+require 'cloudmersive-convert-api-client/models/get_docx_table_by_index_request'
+require 'cloudmersive-convert-api-client/models/get_docx_table_by_index_response'
+require 'cloudmersive-convert-api-client/models/get_docx_table_row_request'
+require 'cloudmersive-convert-api-client/models/get_docx_table_row_response'
 require 'cloudmersive-convert-api-client/models/get_docx_tables_request'
 require 'cloudmersive-convert-api-client/models/get_docx_tables_response'
 require 'cloudmersive-convert-api-client/models/get_image_info_result'
@@ -111,6 +117,8 @@ require 'cloudmersive-convert-api-client/models/set_pdf_metadata_request'
 require 'cloudmersive-convert-api-client/models/split_pdf_result'
 require 'cloudmersive-convert-api-client/models/split_xlsx_worksheet_result'
 require 'cloudmersive-convert-api-client/models/text_conversion_result'
+require 'cloudmersive-convert-api-client/models/update_docx_table_row_request'
+require 'cloudmersive-convert-api-client/models/update_docx_table_row_response'
 require 'cloudmersive-convert-api-client/models/viewer_response'
 require 'cloudmersive-convert-api-client/models/worksheet_result'
 require 'cloudmersive-convert-api-client/models/xlsx_image'

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

@@ -186,6 +186,61 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Deletes a table row in an existing table in a Word DOCX document
+    # Deletes an existing table row in a Word DOCX Document and returns the result.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteDocxTableRowResponse]
+    def edit_document_docx_delete_table_row(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_delete_table_row_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Deletes a table row in an existing table in a Word DOCX document
+    # Deletes an existing table row in a Word DOCX Document and returns the result.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteDocxTableRowResponse, Fixnum, Hash)>] DeleteDocxTableRowResponse data, response status code and response headers
+    def edit_document_docx_delete_table_row_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_delete_table_row ..."
+      end
+      # verify the required parameter 'req_config' is set
+      if @api_client.config.client_side_validation && req_config.nil?
+        fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_delete_table_row"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/delete-table-row"
+
+      # 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(req_config)
+      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 => 'DeleteDocxTableRowResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_delete_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get content of a footer from a Word DOCX document
     # Returns the footer content from a Word Document (DOCX) format file
     # @param req_config Document input request
@@ -406,7 +461,117 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
-    # Get tables in Word DOCX document
+    # Get a specific table by index in a Word DOCX document
+    # Returns the specific table object by its 0-based index in an Office Word Document (DOCX)
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [GetDocxTableByIndexResponse]
+    def edit_document_docx_get_table_by_index(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_get_table_by_index_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Get a specific table by index in a Word DOCX document
+    # Returns the specific table object by its 0-based index in an Office Word Document (DOCX)
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDocxTableByIndexResponse, Fixnum, Hash)>] GetDocxTableByIndexResponse data, response status code and response headers
+    def edit_document_docx_get_table_by_index_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_get_table_by_index ..."
+      end
+      # verify the required parameter 'req_config' is set
+      if @api_client.config.client_side_validation && req_config.nil?
+        fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_table_by_index"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/get-table/by-index"
+
+      # 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(req_config)
+      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 => 'GetDocxTableByIndexResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_table_by_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the contents of an existing table row in an existing table in a Word DOCX document
+    # Gets the contents of an existing table row in a Word DOCX Document and returns the result.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [GetDocxTableRowResponse]
+    def edit_document_docx_get_table_row(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_get_table_row_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Gets the contents of an existing table row in an existing table in a Word DOCX document
+    # Gets the contents of an existing table row in a Word DOCX Document and returns the result.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDocxTableRowResponse, Fixnum, Hash)>] GetDocxTableRowResponse data, response status code and response headers
+    def edit_document_docx_get_table_row_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_get_table_row ..."
+      end
+      # verify the required parameter 'req_config' is set
+      if @api_client.config.client_side_validation && req_config.nil?
+        fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_get_table_row"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/get-table-row"
+
+      # 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(req_config)
+      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 => 'GetDocxTableRowResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_get_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all tables in Word DOCX document
     # Returns all the table objects in an Office Word Document (docx)
     # @param req_config Document input request
     # @param [Hash] opts the optional parameters
@@ -416,7 +581,7 @@ module CloudmersiveConvertApiClient
       return data
     end
 
-    # Get tables in Word DOCX document
+    # Get all tables in Word DOCX document
     # Returns all the table objects in an Office Word Document (docx)
     # @param req_config Document input request
     # @param [Hash] opts the optional parameters
@@ -1066,6 +1231,61 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Update, set contents of a table row in an existing table in a Word DOCX document
+    # Sets the contents of a table row into a DOCX Document and returns the result.  Call Finish Editing on the output URL to complete the operation.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [UpdateDocxTableRowResponse]
+    def edit_document_docx_update_table_row(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_update_table_row_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Update, set contents of a table row in an existing table in a Word DOCX document
+    # Sets the contents of a table row into a DOCX Document and returns the result.  Call Finish Editing on the output URL to complete the operation.
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UpdateDocxTableRowResponse, Fixnum, Hash)>] UpdateDocxTableRowResponse data, response status code and response headers
+    def edit_document_docx_update_table_row_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_update_table_row ..."
+      end
+      # verify the required parameter 'req_config' is set
+      if @api_client.config.client_side_validation && req_config.nil?
+        fail ArgumentError, "Missing the required parameter 'req_config' when calling EditDocumentApi.edit_document_docx_update_table_row"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/update-table-row"
+
+      # 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(req_config)
+      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 => 'UpdateDocxTableRowResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_update_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Download result from document editing
     # Once done editing a document, download the result.  Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.
     # @param req_config Cloudmersive Document URL to complete editing on

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

@@ -0,0 +1,235 @@
+=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
+  # Input to a delete DOCX table row request
+  class DeleteDocxTableRowRequest
+    # Optional: Bytes of the input file to operate on
+    attr_accessor :input_file_bytes
+
+    # 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).
+    attr_accessor :input_file_url
+
+    # Path to the table to delete the row from
+    attr_accessor :table_path
+
+    # 0-based index of the row to delete (e.g. 0, 1, 2, ...) in the table
+    attr_accessor :table_row_row_index
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_file_bytes' => :'InputFileBytes',
+        :'input_file_url' => :'InputFileUrl',
+        :'table_path' => :'TablePath',
+        :'table_row_row_index' => :'TableRowRowIndex'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'input_file_bytes' => :'String',
+        :'input_file_url' => :'String',
+        :'table_path' => :'String',
+        :'table_row_row_index' => :'Integer'
+      }
+    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?(:'InputFileBytes')
+        self.input_file_bytes = attributes[:'InputFileBytes']
+      end
+
+      if attributes.has_key?(:'InputFileUrl')
+        self.input_file_url = attributes[:'InputFileUrl']
+      end
+
+      if attributes.has_key?(:'TablePath')
+        self.table_path = attributes[:'TablePath']
+      end
+
+      if attributes.has_key?(:'TableRowRowIndex')
+        self.table_row_row_index = attributes[:'TableRowRowIndex']
+      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 !@input_file_bytes.nil? && @input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        invalid_properties.push("invalid value for 'input_file_bytes', 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 !@input_file_bytes.nil? && @input_file_bytes !~ 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] input_file_bytes Value to be assigned
+    def input_file_bytes=(input_file_bytes)
+
+      if !input_file_bytes.nil? && input_file_bytes !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
+        fail ArgumentError, "invalid value for 'input_file_bytes', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
+      end
+
+      @input_file_bytes = input_file_bytes
+    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 &&
+          input_file_bytes == o.input_file_bytes &&
+          input_file_url == o.input_file_url &&
+          table_path == o.table_path &&
+          table_row_row_index == o.table_row_row_index
+    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
+      [input_file_bytes, input_file_url, table_path, table_row_row_index].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