aspose_pdf_cloud 24.8.0 → 24.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac5c97cfac0ff947f54e9f380ad0b66d156a49384f5a08ab53d0d89344820a84
-  data.tar.gz: 2fd03bfbf30f838d8dd21514dfe28bcbda7283a1f282beac3b182fa2a49bb131
+  metadata.gz: 28f24d744fc7c852333e5ffe4d013b99b1ce12577cb91e727b7bd399824f7bd5
+  data.tar.gz: '035608878d88906b3095a096696b6dcd4fe62fe9329c9ee745050c3bdfba9dc4'
 SHA512:
-  metadata.gz: 780280be54bd6774f28931fbefdf06cf558d08c0bcddb1b7c63d001c84c950fb21fae19ccafb8d7229e4f82f971f9dfebc1d350c45cecb24c1702eb4f0c2b84a
-  data.tar.gz: 13e418921547b8fb7af995fc0b1a4e0b82bfe6f19a3abe2cf1634499cb358fa815ea57c59fee4fe76a2f551dca526b4d02b913564f0f7baaf813214420d03d86
+  metadata.gz: 79a888d3171d173a2f1254f0b9cfbd8a5a52a840c86edd67b473b7da7fd58aa717d2968ac2141dbe731be6e13dce4ccc1ab058478659975c6faa932aa8a298cd
+  data.tar.gz: 19f75b669468f764865488a7163cac576175fa7d5d6fc61f6fe38897ead797d70a98afdbdef5f8825769fe5c54ec60ab86d2775e2b4aa3603ab2062370493055

data/README.md

@@ -29,9 +29,7 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
 ## Read PDF Formats
 MHT, PCL, PS, XSLFO, MD
 
-## Enhancements in Version 24.8
-- Adding Text stamps to multiple pages.
-- Adding Image stamps to multiple pages.
+## Enhancements in Version 24.9
 - A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
 
 ## Installation
@@ -47,15 +45,15 @@ gem build aspose_pdf_cloud.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./aspose_pdf_cloud-24.8.0.gem
+gem install ./aspose_pdf_cloud-24.9.0.gem
 ```
-(for development, run `gem install --dev ./aspose_pdf_cloud-24.8.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./aspose_pdf_cloud-24.9.0.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 'aspose_pdf_cloud', '~> 24.8.0'
+    gem 'aspose_pdf_cloud', '~> 24.9.0'
 
 ### Install from Git
 

data/docs/DocumentLayers.md

@@ -0,0 +1,9 @@
+# AsposePdfCloud::DocumentLayers
+DocumentLayers response class.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**layers** | [**Array<LayerInfo>**](LayerInfo.md) | List of document Layers. | [optional] 
+
+

data/docs/LayerInfo.md

@@ -0,0 +1,12 @@
+# AsposePdfCloud::LayerInfo
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_number** | **Integer** | Layer Page Number. | 
+**id** | **String** | Layer Id. | [optional] 
+**name** | **String** | Layer Name. | [optional] 
+**locked** | **BOOLEAN** | Gets a value indicating whether the layer is locked. | 
+
+

data/docs/PdfApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**delete_bookmark**](PdfApi.md#delete_bookmark) | **DELETE** /pdf/\{name}/bookmarks/bookmark/\{bookmarkPath} | Delete document bookmark by ID.
 [**delete_document_annotations**](PdfApi.md#delete_document_annotations) | **DELETE** /pdf/\{name}/annotations | Delete all annotations from the document
 [**delete_document_bookmarks**](PdfApi.md#delete_document_bookmarks) | **DELETE** /pdf/\{name}/bookmarks/tree | Delete all document bookmarks.
+[**delete_document_layer**](PdfApi.md#delete_document_layer) | **DELETE** /pdf/\{name}/layers | Remove document layer.
 [**delete_document_link_annotations**](PdfApi.md#delete_document_link_annotations) | **DELETE** /pdf/\{name}/links | Delete all link annotations from the document
 [**delete_document_stamps**](PdfApi.md#delete_document_stamps) | **DELETE** /pdf/\{name}/stamps | Delete all stamps from the document
 [**delete_document_tables**](PdfApi.md#delete_document_tables) | **DELETE** /pdf/\{name}/tables | Delete all tables from the document
@@ -50,6 +51,7 @@ Method | HTTP request | Description
 [**get_document_free_text_annotations**](PdfApi.md#get_document_free_text_annotations) | **GET** /pdf/\{name}/annotations/freetext | Read document free text annotations.
 [**get_document_highlight_annotations**](PdfApi.md#get_document_highlight_annotations) | **GET** /pdf/\{name}/annotations/highlight | Read document highlight annotations.
 [**get_document_ink_annotations**](PdfApi.md#get_document_ink_annotations) | **GET** /pdf/\{name}/annotations/ink | Read document ink annotations.
+[**get_document_layers**](PdfApi.md#get_document_layers) | **GET** /pdf/\{name}/layers | Gets document layers.
 [**get_document_line_annotations**](PdfApi.md#get_document_line_annotations) | **GET** /pdf/\{name}/annotations/line | Read document line annotations.
 [**get_document_list_box_fields**](PdfApi.md#get_document_list_box_fields) | **GET** /pdf/\{name}/fields/listbox | Read document listbox fields.
 [**get_document_movie_annotations**](PdfApi.md#get_document_movie_annotations) | **GET** /pdf/\{name}/annotations/movie | Read document movie annotations.
@@ -266,6 +268,7 @@ Method | HTTP request | Description
 [**put_circle_annotation**](PdfApi.md#put_circle_annotation) | **PUT** /pdf/\{name}/annotations/circle/\{annotationId} | Replace document circle annotation
 [**put_combo_box_field**](PdfApi.md#put_combo_box_field) | **PUT** /pdf/\{name}/fields/combobox/\{fieldName} | Replace document combobox field
 [**put_create_document**](PdfApi.md#put_create_document) | **PUT** /pdf/\{name} | Create empty document.
+[**put_create_pdf_from_layer**](PdfApi.md#put_create_pdf_from_layer) | **PUT** /pdf/\{name}/layers | Create a separate PDF from a PDF Layer and upload resulting file to storage.
 [**put_decrypt_document**](PdfApi.md#put_decrypt_document) | **PUT** /pdf/decrypt | Decrypt document from content.
 [**put_document_display_properties**](PdfApi.md#put_document_display_properties) | **PUT** /pdf/\{name}/displayproperties | Update document display properties.
 [**put_encrypt_document**](PdfApi.md#put_encrypt_document) | **PUT** /pdf/encrypt | Encrypt document from content.
@@ -547,6 +550,33 @@ Name | Type | Description  | Notes
 
 
 
+# **delete_document_layer**
+> AsposeResponse delete_document_layer(name, page_number, layer_id, opts)
+
+Remove document layer.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **page_number** | **Integer**| Layer page. | 
+ **layer_id** | **String**| Layer Id. | 
+ **folder** | **String**| The document folder. | [optional] 
+ **storage** | **String**| The document storage. | [optional] 
+ **pass_base64** | **String**| The password (Base64). | [optional] 
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_document_link_annotations**
 > AsposeResponse delete_document_link_annotations(name, opts)
 
@@ -1508,6 +1538,31 @@ Name | Type | Description  | Notes
 
 
 
+# **get_document_layers**
+> DocumentLayers get_document_layers(name, opts)
+
+Gets document layers.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **folder** | **String**| The document folder. | [optional] 
+ **storage** | **String**| The document storage. | [optional] 
+ **pass_base64** | **String**| The password (Base64). | [optional] 
+
+### Return type
+
+[**DocumentLayers**](DocumentLayers.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_document_line_annotations**
 > LineAnnotationsResponse get_document_line_annotations(name, opts)
 
@@ -7059,6 +7114,34 @@ Name | Type | Description  | Notes
 
 
 
+# **put_create_pdf_from_layer**
+> AsposeResponse put_create_pdf_from_layer(name, page_number, out_path, layer_id, opts)
+
+Create a separate PDF from a PDF Layer and upload resulting file to storage.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **page_number** | **Integer**| The page number. | 
+ **out_path** | **String**| The out path of result image. | 
+ **layer_id** | **String**| Layer Id. | 
+ **folder** | **String**| The document folder. | [optional] 
+ **storage** | **String**| The document storage. | [optional] 
+ **pass_base64** | **String**| The password (Base64). | [optional] 
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **put_decrypt_document**
 > AsposeResponse put_decrypt_document(out_path, password, opts)
 

data/lib/aspose_pdf_cloud/api/pdf_api.rb

@@ -573,6 +573,95 @@ module AsposePdfCloud
       return data, status_code, headers
     end
 
+    # Remove document layer.
+    # 
+    # @param name The document name.
+    # @param page_number Layer page.
+    # @param layer_id Layer Id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :folder The document folder.
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :pass_base64 The password (Base64).
+    # @return [AsposeResponse]
+    def delete_document_layer(name, page_number, layer_id, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = delete_document_layer_with_http_info(name, page_number, layer_id, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = delete_document_layer_with_http_info(name, page_number, layer_id, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Remove document layer.
+    # 
+    # @param name The document name.
+    # @param page_number Layer page.
+    # @param layer_id Layer Id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :folder The document folder.
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :pass_base64 The password (Base64).
+    # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
+    def delete_document_layer_with_http_info(name, page_number, layer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.delete_document_layer ..."
+      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.delete_document_layer"
+      end
+      # verify the required parameter 'page_number' is set
+      if @api_client.config.client_side_validation && page_number.nil?
+        fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.delete_document_layer"
+      end
+      # verify the required parameter 'layer_id' is set
+      if @api_client.config.client_side_validation && layer_id.nil?
+        fail ArgumentError, "Missing the required parameter 'layer_id' when calling PdfApi.delete_document_layer"
+      end
+      # resource path
+      local_var_path = "/pdf/{name}/layers".sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageNumber'] = page_number
+      query_params[:'layerId'] = layer_id
+      query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
+      query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].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(:DELETE, 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#delete_document_layer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete all link annotations from the document
     # 
     # @param name The document name.
@@ -3505,6 +3594,81 @@ module AsposePdfCloud
       return data, status_code, headers
     end
 
+    # Gets document layers.
+    # 
+    # @param name The document name.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :folder The document folder.
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :pass_base64 The password (Base64).
+    # @return [DocumentLayers]
+    def get_document_layers(name, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = get_document_layers_with_http_info(name, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = get_document_layers_with_http_info(name, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Gets document layers.
+    # 
+    # @param name The document name.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :folder The document folder.
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :pass_base64 The password (Base64).
+    # @return [Array<(DocumentLayers, Fixnum, Hash)>] DocumentLayers data, response status code and response headers
+    def get_document_layers_with_http_info(name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.get_document_layers ..."
+      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.get_document_layers"
+      end
+      # resource path
+      local_var_path = "/pdf/{name}/layers".sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
+      query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].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(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DocumentLayers')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PdfApi#get_document_layers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read document line annotations.
     # 
     # @param name The document name.
@@ -20834,6 +20998,102 @@ module AsposePdfCloud
       return data, status_code, headers
     end
 
+    # Create a separate PDF from a PDF Layer and upload resulting file to storage.
+    # 
+    # @param name The document name.
+    # @param page_number The page number.
+    # @param out_path The out path of result image.
+    # @param layer_id Layer Id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :folder The document folder.
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :pass_base64 The password (Base64).
+    # @return [AsposeResponse]
+    def put_create_pdf_from_layer(name, page_number, out_path, layer_id, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = put_create_pdf_from_layer_with_http_info(name, page_number, out_path, layer_id, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = put_create_pdf_from_layer_with_http_info(name, page_number, out_path, layer_id, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Create a separate PDF from a PDF Layer and upload resulting file to storage.
+    # 
+    # @param name The document name.
+    # @param page_number The page number.
+    # @param out_path The out path of result image.
+    # @param layer_id Layer Id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :folder The document folder.
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :pass_base64 The password (Base64).
+    # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
+    def put_create_pdf_from_layer_with_http_info(name, page_number, out_path, layer_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.put_create_pdf_from_layer ..."
+      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.put_create_pdf_from_layer"
+      end
+      # verify the required parameter 'page_number' is set
+      if @api_client.config.client_side_validation && page_number.nil?
+        fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.put_create_pdf_from_layer"
+      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.put_create_pdf_from_layer"
+      end
+      # verify the required parameter 'layer_id' is set
+      if @api_client.config.client_side_validation && layer_id.nil?
+        fail ArgumentError, "Missing the required parameter 'layer_id' when calling PdfApi.put_create_pdf_from_layer"
+      end
+      # resource path
+      local_var_path = "/pdf/{name}/layers".sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageNumber'] = page_number
+      query_params[:'outPath'] = out_path
+      query_params[:'layerId'] = layer_id
+      query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
+      query_params[:'passBase64'] = opts[:'pass_base64'] if !opts[:'pass_base64'].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(:PUT, 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#put_create_pdf_from_layer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Decrypt document from content.
     # 
     # @param out_path Full resulting filename (ex. /folder1/folder2/result.doc)

data/lib/aspose_pdf_cloud/models/document_layers.rb

@@ -0,0 +1,201 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2024 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
+  # DocumentLayers response class.
+  class DocumentLayers
+    # List of document Layers.
+    attr_accessor :layers
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'layers' => :'Layers'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'layers' => :'Array<LayerInfo>'
+      }
+    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?(:'Layers')
+        if (value = attributes[:'Layers']).is_a?(Array)
+          self.layers = value
+        end
+      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
+      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 &&
+          layers == o.layers
+    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
+      [layers].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

data/lib/aspose_pdf_cloud/models/layer_info.rb

@@ -0,0 +1,239 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2024 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
+
+  class LayerInfo
+    # Layer Page Number.
+    attr_accessor :page_number
+
+    # Layer Id.
+    attr_accessor :id
+
+    # Layer Name.
+    attr_accessor :name
+
+    # Gets a value indicating whether the layer is locked.
+    attr_accessor :locked
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'page_number' => :'PageNumber',
+        :'id' => :'Id',
+        :'name' => :'Name',
+        :'locked' => :'Locked'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'page_number' => :'Integer',
+        :'id' => :'String',
+        :'name' => :'String',
+        :'locked' => :'BOOLEAN'
+      }
+    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?(:'Id')
+        self.id = attributes[:'Id']
+      end
+
+      if attributes.has_key?(:'Name')
+        self.name = attributes[:'Name']
+      end
+
+      if attributes.has_key?(:'Locked')
+        self.locked = attributes[:'Locked']
+      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 @page_number.nil?
+        invalid_properties.push("invalid value for 'page_number', page_number cannot be nil.")
+      end
+
+      if @locked.nil?
+        invalid_properties.push("invalid value for 'locked', locked cannot be nil.")
+      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 @page_number.nil?
+      return false if @locked.nil?
+      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 &&
+          id == o.id &&
+          name == o.name &&
+          locked == o.locked
+    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, id, name, locked].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

data/lib/aspose_pdf_cloud/version.rb

@@ -20,5 +20,5 @@ SOFTWARE.
 =end
 
 module AsposePdfCloud
-  VERSION = "24.8.0"
+  VERSION = "24.9.0"
 end

data/lib/aspose_pdf_cloud.rb

@@ -56,6 +56,7 @@ require_relative 'aspose_pdf_cloud/models/doc_format'
 require_relative 'aspose_pdf_cloud/models/doc_mdp_access_permission_type'
 require_relative 'aspose_pdf_cloud/models/doc_recognition_mode'
 require_relative 'aspose_pdf_cloud/models/document_config'
+require_relative 'aspose_pdf_cloud/models/document_layers'
 require_relative 'aspose_pdf_cloud/models/document_privilege'
 require_relative 'aspose_pdf_cloud/models/epub_recognition_mode'
 require_relative 'aspose_pdf_cloud/models/error'
@@ -80,6 +81,7 @@ require_relative 'aspose_pdf_cloud/models/image_src_type'
 require_relative 'aspose_pdf_cloud/models/image_template'
 require_relative 'aspose_pdf_cloud/models/image_templates_request'
 require_relative 'aspose_pdf_cloud/models/justification'
+require_relative 'aspose_pdf_cloud/models/layer_info'
 require_relative 'aspose_pdf_cloud/models/letters_positioning_methods'
 require_relative 'aspose_pdf_cloud/models/line_ending'
 require_relative 'aspose_pdf_cloud/models/line_intent'

data/test/pdf_tests.rb

@@ -6556,4 +6556,46 @@ class PdfTests < Minitest::Test
     response = @pdf_api.post_import_fields_from_xml(file_name, opts)
     assert(response, 'Failed to import fields from xml.')
   end
+
+  # Layers Tests
+
+  def test_get_document_layers
+    file_name = 'PdfWithLayers.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.get_document_layers(file_name, opts)
+    assert_equal(2, response[0].layers.count(), 'Failed to read document layers.')
+  end
+
+  def test_delete_document_layer
+    file_name = 'PdfWithLayers.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.delete_document_layer(file_name, 1, "oc1", opts)
+    assert(response, 'Failed to delete document layer.')
+
+    response = @pdf_api.get_document_layers(file_name, opts)
+    assert_equal(1, response[0].layers.count(), 'Failed to read document layers.')
+  end
+
+  def test_put_create_pdf_from_layer
+    file_name = 'PdfWithLayers.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.put_create_pdf_from_layer(file_name, 1, "output.pdf", "oc1", opts)
+    assert(response, 'Failed to create a separate PDF from a PDF Layer.')
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspose_pdf_cloud
 version: !ruby/object:Gem::Version
-  version: 24.8.0
+  version: 24.9.0
 platform: ruby
 authors:
 - Aspose PDF Cloud
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -245,6 +245,7 @@ files:
 - docs/DocRecognitionMode.md
 - docs/Document.md
 - docs/DocumentConfig.md
+- docs/DocumentLayers.md
 - docs/DocumentPageResponse.md
 - docs/DocumentPagesResponse.md
 - docs/DocumentPrivilege.md
@@ -305,6 +306,7 @@ files:
 - docs/InkAnnotations.md
 - docs/InkAnnotationsResponse.md
 - docs/Justification.md
+- docs/LayerInfo.md
 - docs/LettersPositioningMethods.md
 - docs/LineAnnotation.md
 - docs/LineAnnotationResponse.md
@@ -536,6 +538,7 @@ files:
 - lib/aspose_pdf_cloud/models/doc_recognition_mode.rb
 - lib/aspose_pdf_cloud/models/document.rb
 - lib/aspose_pdf_cloud/models/document_config.rb
+- lib/aspose_pdf_cloud/models/document_layers.rb
 - lib/aspose_pdf_cloud/models/document_page_response.rb
 - lib/aspose_pdf_cloud/models/document_pages_response.rb
 - lib/aspose_pdf_cloud/models/document_privilege.rb
@@ -596,6 +599,7 @@ files:
 - lib/aspose_pdf_cloud/models/ink_annotations.rb
 - lib/aspose_pdf_cloud/models/ink_annotations_response.rb
 - lib/aspose_pdf_cloud/models/justification.rb
+- lib/aspose_pdf_cloud/models/layer_info.rb
 - lib/aspose_pdf_cloud/models/letters_positioning_methods.rb
 - lib/aspose_pdf_cloud/models/line_annotation.rb
 - lib/aspose_pdf_cloud/models/line_annotation_response.rb
@@ -789,6 +793,7 @@ files:
 - test_data/PdfWithEmbeddedFiles.pdf
 - test_data/PdfWithImages.pdf
 - test_data/PdfWithImages2.pdf
+- test_data/PdfWithLayers.pdf
 - test_data/PdfWithLinks.pdf
 - test_data/PdfWithScreenAnnotations.pdf
 - test_data/PdfWithTable.pdf