aspose_pdf_cloud 23.3.0 → 23.4.0

data/docs/OrganizeDocumentData.md

@@ -0,0 +1,10 @@
+# AsposePdfCloud::OrganizeDocumentData
+Data for document organizing.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | Full filename of the document for organizing. | 
+**pages** | **String** | 1-based page numbers of the document that make up the resulting document. | 
+
+

data/docs/OrganizeDocumentRequest.md

@@ -0,0 +1,9 @@
+# AsposePdfCloud::OrganizeDocumentRequest
+Documents data for organizing.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | [**Array<OrganizeDocumentData>**](OrganizeDocumentData.md) | List of document data for organizing. | 
+
+

data/docs/PdfApi.md

@@ -214,6 +214,8 @@ Method | HTTP request | Description
 [**post_list_box_fields**](PdfApi.md#post_list_box_fields) | **POST** /pdf/\{name}/fields/listbox | Add document listbox fields.
 [**post_move_page**](PdfApi.md#post_move_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/movePage | Move page to new position.
 [**post_optimize_document**](PdfApi.md#post_optimize_document) | **POST** /pdf/\{name}/optimize | Optimize document.
+[**post_organize_document**](PdfApi.md#post_organize_document) | **POST** /pdf/\{name}/organize | Merge selected pages of a document.
+[**post_organize_documents**](PdfApi.md#post_organize_documents) | **POST** /pdf/organize | Merge selected pages of different documents.
 [**post_page_caret_annotations**](PdfApi.md#post_page_caret_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/caret | Add document page caret annotations.
 [**post_page_certify**](PdfApi.md#post_page_certify) | **POST** /pdf/\{name}/pages/\{pageNumber}/certify | Certify document page.
 [**post_page_circle_annotations**](PdfApi.md#post_page_circle_annotations) | **POST** /pdf/\{name}/pages/\{pageNumber}/annotations/circle | Add document page circle annotations.
@@ -5677,6 +5679,56 @@ Name | Type | Description  | Notes
 
 
 
+# **post_organize_document**
+> AsposeResponse post_organize_document(name, pages, out_path, opts)
+
+Merge selected pages of a document.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The original document name. | 
+ **pages** | **String**| 1-based page numbers of the source document that make up the resulting document. | 
+ **out_path** | **String**| Full filename of the resulting document. | 
+ **storage** | **String**| The documents storage. | [optional] 
+ **folder** | **String**| The source document folder. | [optional] 
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_organize_documents**
+> AsposeResponse post_organize_documents(organize_documents, out_path, opts)
+
+Merge selected pages of different documents.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organize_documents** | [**OrganizeDocumentRequest**](OrganizeDocumentRequest.md)| Array of OrganizeDocumentData to make up the resulting document. | 
+ **out_path** | **String**| Full filename of the resulting document. | 
+ **storage** | **String**| The documents storage. | [optional] 
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **post_page_caret_annotations**
 > AsposeResponse post_page_caret_annotations(name, page_number, annotations, opts)
 

data/lib/aspose_pdf_cloud/api/pdf_api.rb

@@ -16481,6 +16481,179 @@ module AsposePdfCloud
       return data, status_code, headers
     end
 
+    # Merge selected pages of a document.
+    # 
+    # @param name The original document name.
+    # @param pages 1-based page numbers of the source document that make up the resulting document.
+    # @param out_path Full filename of the resulting document.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The documents storage.
+    # @option opts [String] :folder The source document folder.
+    # @return [AsposeResponse]
+    def post_organize_document(name, pages, out_path, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = post_organize_document_with_http_info(name, pages, out_path, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = post_organize_document_with_http_info(name, pages, out_path, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Merge selected pages of a document.
+    # 
+    # @param name The original document name.
+    # @param pages 1-based page numbers of the source document that make up the resulting document.
+    # @param out_path Full filename of the resulting document.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The documents storage.
+    # @option opts [String] :folder The source document folder.
+    # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
+    def post_organize_document_with_http_info(name, pages, out_path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.post_organize_document ..."
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_organize_document"
+      end
+      # verify the required parameter 'pages' is set
+      if @api_client.config.client_side_validation && pages.nil?
+        fail ArgumentError, "Missing the required parameter 'pages' when calling PdfApi.post_organize_document"
+      end
+      if @api_client.config.client_side_validation && pages.to_s.length < 1
+        fail ArgumentError, 'invalid value for "pages" when calling PdfApi.post_organize_document, the character length must be great than or equal to 1.'
+      end
+
+      # verify the required parameter 'out_path' is set
+      if @api_client.config.client_side_validation && out_path.nil?
+        fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.post_organize_document"
+      end
+      if @api_client.config.client_side_validation && out_path.to_s.length < 1
+        fail ArgumentError, 'invalid value for "out_path" when calling PdfApi.post_organize_document, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = "/pdf/{name}/organize".sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pages'] = pages
+      query_params[:'outPath'] = out_path
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
+      query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+      # Fix header in file
+      post_body = nil
+
+      # http body (model)
+      # Fix header in file
+      # post_body = nil
+      auth_names = ['JWT']
+      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 => 'AsposeResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PdfApi#post_organize_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Merge selected pages of different documents.
+    # 
+    # @param organize_documents Array of OrganizeDocumentData to make up the resulting document.
+    # @param out_path Full filename of the resulting document.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The documents storage.
+    # @return [AsposeResponse]
+    def post_organize_documents(organize_documents, out_path, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = post_organize_documents_with_http_info(organize_documents, out_path, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = post_organize_documents_with_http_info(organize_documents, out_path, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Merge selected pages of different documents.
+    # 
+    # @param organize_documents Array of OrganizeDocumentData to make up the resulting document.
+    # @param out_path Full filename of the resulting document.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The documents storage.
+    # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
+    def post_organize_documents_with_http_info(organize_documents, out_path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.post_organize_documents ..."
+      end
+      # verify the required parameter 'organize_documents' is set
+      if @api_client.config.client_side_validation && organize_documents.nil?
+        fail ArgumentError, "Missing the required parameter 'organize_documents' when calling PdfApi.post_organize_documents"
+      end
+      # verify the required parameter 'out_path' is set
+      if @api_client.config.client_side_validation && out_path.nil?
+        fail ArgumentError, "Missing the required parameter 'out_path' when calling PdfApi.post_organize_documents"
+      end
+      if @api_client.config.client_side_validation && out_path.to_s.length < 1
+        fail ArgumentError, 'invalid value for "out_path" when calling PdfApi.post_organize_documents, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = "/pdf/organize"
+
+      # query parameters
+      query_params = {}
+      query_params[:'outPath'] = out_path
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+      # Fix header in file
+      post_body = nil
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(organize_documents)
+      auth_names = ['JWT']
+      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 => 'AsposeResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PdfApi#post_organize_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Add document page caret annotations.
     # 
     # @param name The document name.

data/lib/aspose_pdf_cloud/models/organize_document_data.rb

@@ -0,0 +1,257 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2023 Aspose.PDF Cloud
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+require 'date'
+require 'time'
+
+module AsposePdfCloud
+  # Data for document organizing.
+  class OrganizeDocumentData
+    # Full filename of the document for organizing.
+    attr_accessor :path
+
+    # 1-based page numbers of the document that make up the resulting document.
+    attr_accessor :pages
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'path' => :'Path',
+        :'pages' => :'Pages'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'path' => :'String',
+        :'pages' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'Path')
+        self.path = attributes[:'Path']
+      end
+
+      if attributes.has_key?(:'Pages')
+        self.pages = attributes[:'Pages']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @path.nil?
+        invalid_properties.push("invalid value for 'path', path cannot be nil.")
+      end
+
+      if @path.to_s.length < 1
+        invalid_properties.push("invalid value for 'path', the character length must be great than or equal to 1.")
+      end
+
+      if @pages.nil?
+        invalid_properties.push("invalid value for 'pages', pages cannot be nil.")
+      end
+
+      if @pages.to_s.length < 1
+        invalid_properties.push("invalid value for 'pages', the character length must be great than or equal to 1.")
+      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 @path.nil?
+      return false if @path.to_s.length < 1
+      return false if @pages.nil?
+      return false if @pages.to_s.length < 1
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] path Value to be assigned
+    def path=(path)
+      if path.nil?
+        fail ArgumentError, "path cannot be nil"
+      end
+
+      if path.to_s.length < 1
+        fail ArgumentError, "invalid value for 'path', the character length must be great than or equal to 1."
+      end
+
+      @path = path
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pages Value to be assigned
+    def pages=(pages)
+      if pages.nil?
+        fail ArgumentError, "pages cannot be nil"
+      end
+
+      if pages.to_s.length < 1
+        fail ArgumentError, "invalid value for 'pages', the character length must be great than or equal to 1."
+      end
+
+      @pages = pages
+    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 &&
+          path == o.path &&
+          pages == o.pages
+    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
+      [path, pages].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 = AsposePdfCloud.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