cloudmersive-convert-api-client 1.5.1 → 1.5.2

data/lib/cloudmersive-convert-api-client/models/remove_docx_pages_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 Remove Word DOCX Document Pages request
+  class RemoveDocxPagesRequest
+    # 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
+
+    # Page number (1-based) to start deleting pages; inclusive
+    attr_accessor :start_delete_page_number
+
+    # Page number (1-based) to stop deleting pages; inclusive
+    attr_accessor :end_delete_page_number
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_file_bytes' => :'InputFileBytes',
+        :'input_file_url' => :'InputFileUrl',
+        :'start_delete_page_number' => :'StartDeletePageNumber',
+        :'end_delete_page_number' => :'EndDeletePageNumber'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'input_file_bytes' => :'String',
+        :'input_file_url' => :'String',
+        :'start_delete_page_number' => :'Integer',
+        :'end_delete_page_number' => :'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?(:'StartDeletePageNumber')
+        self.start_delete_page_number = attributes[:'StartDeletePageNumber']
+      end
+
+      if attributes.has_key?(:'EndDeletePageNumber')
+        self.end_delete_page_number = attributes[:'EndDeletePageNumber']
+      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 &&
+          start_delete_page_number == o.start_delete_page_number &&
+          end_delete_page_number == o.end_delete_page_number
+    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, start_delete_page_number, end_delete_page_number].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.1"
+  VERSION = "1.5.2"
 end

data/spec/api/convert_web_api_spec.rb

@@ -33,7 +33,7 @@ describe 'ConvertWebApi' do
   end
 
   # unit tests for convert_web_html_to_docx
-  # 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/spec/api/edit_document_api_spec.rb

@@ -56,6 +56,18 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_docx_delete_pages
+  # 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]
+  describe 'edit_document_docx_delete_pages 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 edit_document_docx_get_headers_and_footers
   # Get content of a footer from a Word DOCX document
   # Returns the footer content from a Word Document (DOCX) format file
@@ -152,6 +164,30 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_docx_insert_table_row
+  # 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]
+  describe 'edit_document_docx_insert_table_row 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 edit_document_docx_pages
+  # 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]
+  describe 'edit_document_docx_pages 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 edit_document_docx_remove_headers_and_footers
   # 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.

data/spec/api/edit_pdf_api_spec.rb

@@ -98,6 +98,18 @@ describe 'EditPdfApi' do
     end
   end
 
+  # unit tests for edit_pdf_get_pdf_text_by_pages
+  # 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]
+  describe 'edit_pdf_get_pdf_text_by_pages 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 edit_pdf_insert_pages
   # 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).

data/spec/models/docx_page_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::DocxPage
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DocxPage' do
+  before do
+    # run before each test
+    @instance = CloudmersiveConvertApiClient::DocxPage.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DocxPage' do
+    it 'should create an instance of DocxPage' do
+      expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::DocxPage)
+    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 "paragraphs"' 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/get_docx_pages_request_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::GetDocxPagesRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'GetDocxPagesRequest' do
+  before do
+    # run before each test
+    @instance = CloudmersiveConvertApiClient::GetDocxPagesRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GetDocxPagesRequest' do
+    it 'should create an instance of GetDocxPagesRequest' do
+      expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::GetDocxPagesRequest)
+    end
+  end
+  describe 'test attribute "input_file_bytes"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "input_file_url"' 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/get_docx_pages_response_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::GetDocxPagesResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'GetDocxPagesResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveConvertApiClient::GetDocxPagesResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GetDocxPagesResponse' do
+    it 'should create an instance of GetDocxPagesResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::GetDocxPagesResponse)
+    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
+
+  describe 'test attribute "pages"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "page_count"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+