cloudmersive-convert-api-client 1.5.1 → 1.5.2

data/docs/PdfPageText.md

@@ -0,0 +1,9 @@
+# CloudmersiveConvertApiClient::PdfPageText
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_number** | **Integer** | Page number of the page (1-based) | [optional] 
+**page_text** | **String** | Text of the page | [optional] 
+
+

data/docs/PdfTextByPageResult.md

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

data/docs/RemoveDocxPagesRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveConvertApiClient::RemoveDocxPagesRequest
+
+## 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] 
+**start_delete_page_number** | **Integer** | Page number (1-based) to start deleting pages; inclusive | [optional] 
+**end_delete_page_number** | **Integer** | Page number (1-based) to stop deleting pages; inclusive | [optional] 
+
+

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

@@ -31,6 +31,7 @@ require 'cloudmersive-convert-api-client/models/docx_header'
 require 'cloudmersive-convert-api-client/models/docx_image'
 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_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'
@@ -56,6 +57,8 @@ 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_pages_request'
+require 'cloudmersive-convert-api-client/models/get_docx_pages_response'
 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'
@@ -82,6 +85,8 @@ require 'cloudmersive-convert-api-client/models/html_to_pdf_request'
 require 'cloudmersive-convert-api-client/models/html_to_png_request'
 require 'cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_request'
 require 'cloudmersive-convert-api-client/models/insert_docx_insert_paragraph_response'
+require 'cloudmersive-convert-api-client/models/insert_docx_table_row_request'
+require 'cloudmersive-convert-api-client/models/insert_docx_table_row_response'
 require 'cloudmersive-convert-api-client/models/insert_docx_tables_request'
 require 'cloudmersive-convert-api-client/models/insert_docx_tables_response'
 require 'cloudmersive-convert-api-client/models/insert_xlsx_worksheet_request'
@@ -92,9 +97,12 @@ require 'cloudmersive-convert-api-client/models/pdf_document'
 require 'cloudmersive-convert-api-client/models/pdf_form_field'
 require 'cloudmersive-convert-api-client/models/pdf_form_fields'
 require 'cloudmersive-convert-api-client/models/pdf_metadata'
+require 'cloudmersive-convert-api-client/models/pdf_page_text'
+require 'cloudmersive-convert-api-client/models/pdf_text_by_page_result'
 require 'cloudmersive-convert-api-client/models/pdf_to_png_result'
 require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_request'
 require 'cloudmersive-convert-api-client/models/remove_docx_headers_and_footers_response'
+require 'cloudmersive-convert-api-client/models/remove_docx_pages_request'
 require 'cloudmersive-convert-api-client/models/replace_string_request'
 require 'cloudmersive-convert-api-client/models/screenshot_request'
 require 'cloudmersive-convert-api-client/models/set_form_field_value'

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

@@ -20,7 +20,7 @@ module CloudmersiveConvertApiClient
       @api_client = api_client
     end
 
-    # Convert HTML to DOCX
+    # Convert HTML to Word DOCX Document
     # Convert HTML to Office Word Document (DOCX) format
     # @param input_request HTL input to convert to DOCX
     # @param [Hash] opts the optional parameters
@@ -30,7 +30,7 @@ module CloudmersiveConvertApiClient
       return data
     end
 
-    # Convert HTML to DOCX
+    # Convert HTML to Word DOCX Document
     # Convert HTML to Office Word Document (DOCX) format
     # @param input_request HTL input to convert to DOCX
     # @param [Hash] opts the optional parameters

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

@@ -131,6 +131,61 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Delete, remove pages from a Word DOCX document
+    # Returns the pages and contents of each page defined in the Word Document (DOCX) format file
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def edit_document_docx_delete_pages(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_delete_pages_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Delete, remove pages from a Word DOCX document
+    # Returns the pages and contents of each page defined in the Word Document (DOCX) format file
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def edit_document_docx_delete_pages_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_delete_pages ..."
+      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_pages"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/delete-pages"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_delete_pages\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
@@ -571,6 +626,116 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Insert a new row into an existing table in a Word DOCX document
+    # Adds a new 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 [InsertDocxTableRowResponse]
+    def edit_document_docx_insert_table_row(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_insert_table_row_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Insert a new row into an existing table in a Word DOCX document
+    # Adds a new 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<(InsertDocxTableRowResponse, Fixnum, Hash)>] InsertDocxTableRowResponse data, response status code and response headers
+    def edit_document_docx_insert_table_row_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_insert_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_insert_table_row"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/insert-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 => 'InsertDocxTableRowResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_insert_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get pages and content from a Word DOCX document
+    # Returns the pages and contents of each page defined in the Word Document (DOCX) format file
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [GetDocxPagesResponse]
+    def edit_document_docx_pages(req_config, opts = {})
+      data, _status_code, _headers = edit_document_docx_pages_with_http_info(req_config, opts)
+      return data
+    end
+
+    # Get pages and content from a Word DOCX document
+    # Returns the pages and contents of each page defined in the Word Document (DOCX) format file
+    # @param req_config Document input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetDocxPagesResponse, Fixnum, Hash)>] GetDocxPagesResponse data, response status code and response headers
+    def edit_document_docx_pages_with_http_info(req_config, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditDocumentApi.edit_document_docx_pages ..."
+      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_pages"
+      end
+      # resource path
+      local_var_path = "/convert/edit/docx/get-pages"
+
+      # 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 => 'GetDocxPagesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditDocumentApi#edit_document_docx_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Remove headers and footers from Word DOCX document
     # Remove all headers, or footers, or both from 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/api/edit_pdf_api.rb

@@ -330,6 +330,62 @@ module CloudmersiveConvertApiClient
       return data, status_code, headers
     end
 
+    # Get text in a PDF document by page
+    # Gets the text in a PDF by page
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [PdfTextByPageResult]
+    def edit_pdf_get_pdf_text_by_pages(input_file, opts = {})
+      data, _status_code, _headers = edit_pdf_get_pdf_text_by_pages_with_http_info(input_file, opts)
+      return data
+    end
+
+    # Get text in a PDF document by page
+    # Gets the text in a PDF by page
+    # @param input_file Input file to perform the operation on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PdfTextByPageResult, Fixnum, Hash)>] PdfTextByPageResult data, response status code and response headers
+    def edit_pdf_get_pdf_text_by_pages_with_http_info(input_file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: EditPdfApi.edit_pdf_get_pdf_text_by_pages ..."
+      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 EditPdfApi.edit_pdf_get_pdf_text_by_pages"
+      end
+      # resource path
+      local_var_path = "/convert/edit/pdf/pages/get-text"
+
+      # 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 => 'PdfTextByPageResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_get_pdf_text_by_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Insert / copy pages from one PDF document into another
     # Copy one or more pages from one PDF document (source document) and insert them into a second PDF document (destination document).
     # @param source_file Source PDF file to copy pages from.

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

@@ -0,0 +1,201 @@
+=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
+
+  class DocxPage
+    # Page number of this page, 1-based
+    attr_accessor :page_number
+
+    # All paragraphs anywhere in the document; these objects are not sequentially placed but are scatted across document
+    attr_accessor :paragraphs
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'page_number' => :'PageNumber',
+        :'paragraphs' => :'Paragraphs'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'page_number' => :'Integer',
+        :'paragraphs' => :'Array<DocxParagraph>'
+      }
+    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?(:'Paragraphs')
+        if (value = attributes[:'Paragraphs']).is_a?(Array)
+          self.paragraphs = value
+        end
+      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 &&
+          page_number == o.page_number &&
+          paragraphs == o.paragraphs
+    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, paragraphs].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