aspose_pdf_cloud 19.12.0 → 20.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2c180ec253116a969d0f960906937bffa39187606d7fe2824c55a2a586958f
-  data.tar.gz: 472a342969e7d273d63f0fcda15d2731d93cfab7f559b7eeebc778640e933a2e
+  metadata.gz: 2cff3ea26d275e20541506fb7bbc9a5b09b65983f78deedb5075a0589313dfab
+  data.tar.gz: e5f315a1e4cc4b784b0192af45a07609f8ae3547d7c5fb2f4a90dd899843cef9
 SHA512:
-  metadata.gz: 34aefab7507437d944747188c4360e5223f08732b74be2ff0793dddf8918d4df4a3a1568d7034f3a69f8113d325d73319344fda7f873b638857251475629dfc0
-  data.tar.gz: dc4b321e619a9f7d943c128146fc5d970c0f8722d9ecf5be6c2872ef763a2c868f128db8b7e263058cf88712f42bcfbcab0514688ed8c88e4730022ba44215bc
+  metadata.gz: 2a42718f2b379366afd02eb01de6cd457adfa6ef8414294ac9a37945cbe6096fb999127e4034adcdcb6281472185aa438467bfb9865d84b94785cab5ad572f7e
+  data.tar.gz: 11c0cf4b616c04f9869d8cfa93178c2cc6537282a9adea8d00ed0fab8b0d584855181818fe000d7d2cb799a61ee631d894a25e2dccd5abbbbe2db94ab476566a

data/README.md

@@ -1,7 +1,7 @@
 # Aspose.PDF Cloud
 
 - API version: 3.0
-- Package version: 19.12.0
+- Package version: 20.1.0
 
 [Aspose.PDF Cloud](https://products.aspose.cloud/pdf) is a true REST API that enables you to perform a wide range of document processing operations including creation, manipulation, conversion and rendering of Pdf documents in the cloud.
 
@@ -9,6 +9,8 @@ Our Cloud SDKs are wrappers around REST API in various programming languages, al
 
 These SDKs are now fully supported. If you have any questions, see any bugs or have enhancement request, feel free to reach out to us at [Free Support Forums](https://forum.aspose.cloud/c/pdf).
 
+Unlock your PDF document using the Aspose.PDF online service https://products.aspose.app/pdf/unlock.
+
 ## Installation
 
 ### Build a gem
@@ -22,15 +24,15 @@ gem build aspose_pdf_cloud.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./aspose_pdf_cloud-19.12.0.gem
+gem install ./aspose_pdf_cloud-20.1.0.gem
 ```
-(for development, run `gem install --dev ./aspose_pdf_cloud-19.12.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./aspose_pdf_cloud-20.1.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', '~> 19.12.0'
+    gem 'aspose_pdf_cloud', '~> 20.1.0'
 
 ### Install from Git
 
@@ -328,6 +330,7 @@ Class | Method | HTTP request | Description
 *AsposePdfCloud::PdfApi* | [**post_radio_button_fields**](docs/PdfApi.md#post_radio_button_fields) | **POST** /pdf/\{name}/fields/radiobutton | Add document RadioButton fields.
 *AsposePdfCloud::PdfApi* | [**post_sign_document**](docs/PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
 *AsposePdfCloud::PdfApi* | [**post_sign_page**](docs/PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
+*AsposePdfCloud::PdfApi* | [**post_signature_field**](docs/PdfApi.md#post_signature_field) | **POST** /pdf/\{name}/fields/signature | Add document signature field.
 *AsposePdfCloud::PdfApi* | [**post_split_document**](docs/PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
 *AsposePdfCloud::PdfApi* | [**post_text_box_fields**](docs/PdfApi.md#post_text_box_fields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
 *AsposePdfCloud::PdfApi* | [**put_add_new_page**](docs/PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
@@ -420,6 +423,7 @@ Class | Method | HTTP request | Description
 *AsposePdfCloud::PdfApi* | [**put_screen_annotation_data_extract**](docs/PdfApi.md#put_screen_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId}/data/extract | Extract document screen annotation content to storage
 *AsposePdfCloud::PdfApi* | [**put_searchable_document**](docs/PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document.
 *AsposePdfCloud::PdfApi* | [**put_set_property**](docs/PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
+*AsposePdfCloud::PdfApi* | [**put_signature_field**](docs/PdfApi.md#put_signature_field) | **PUT** /pdf/\{name}/fields/signature/\{fieldName} | Replace document signature field.
 *AsposePdfCloud::PdfApi* | [**put_sound_annotation**](docs/PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation
 *AsposePdfCloud::PdfApi* | [**put_sound_annotation_data_extract**](docs/PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage
 *AsposePdfCloud::PdfApi* | [**put_square_annotation**](docs/PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation

data/docs/PdfApi.md

@@ -243,6 +243,7 @@ Method | HTTP request | Description
 [**post_radio_button_fields**](PdfApi.md#post_radio_button_fields) | **POST** /pdf/\{name}/fields/radiobutton | Add document RadioButton fields.
 [**post_sign_document**](PdfApi.md#post_sign_document) | **POST** /pdf/\{name}/sign | Sign document.
 [**post_sign_page**](PdfApi.md#post_sign_page) | **POST** /pdf/\{name}/pages/\{pageNumber}/sign | Sign page.
+[**post_signature_field**](PdfApi.md#post_signature_field) | **POST** /pdf/\{name}/fields/signature | Add document signature field.
 [**post_split_document**](PdfApi.md#post_split_document) | **POST** /pdf/\{name}/split | Split document to parts.
 [**post_text_box_fields**](PdfApi.md#post_text_box_fields) | **POST** /pdf/\{name}/fields/textbox | Add document text box fields.
 [**put_add_new_page**](PdfApi.md#put_add_new_page) | **PUT** /pdf/\{name}/pages | Add new page to end of the document.
@@ -335,6 +336,7 @@ Method | HTTP request | Description
 [**put_screen_annotation_data_extract**](PdfApi.md#put_screen_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/screen/\{annotationId}/data/extract | Extract document screen annotation content to storage
 [**put_searchable_document**](PdfApi.md#put_searchable_document) | **PUT** /pdf/\{name}/ocr | Create searchable PDF document. Generate OCR layer for images in input PDF document.
 [**put_set_property**](PdfApi.md#put_set_property) | **PUT** /pdf/\{name}/documentproperties/\{propertyName} | Add/update document property.
+[**put_signature_field**](PdfApi.md#put_signature_field) | **PUT** /pdf/\{name}/fields/signature/\{fieldName} | Replace document signature field.
 [**put_sound_annotation**](PdfApi.md#put_sound_annotation) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId} | Replace document sound annotation
 [**put_sound_annotation_data_extract**](PdfApi.md#put_sound_annotation_data_extract) | **PUT** /pdf/\{name}/annotations/sound/\{annotationId}/data/extract | Extract document sound annotation content to storage
 [**put_square_annotation**](PdfApi.md#put_square_annotation) | **PUT** /pdf/\{name}/annotations/square/\{annotationId} | Replace document square annotation
@@ -6421,6 +6423,31 @@ Name | Type | Description  | Notes
 
 
 
+# **post_signature_field**
+> AsposeResponse post_signature_field(name, field, opts)
+
+Add document signature field.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **field** | [**SignatureField**](SignatureField.md)| The field. | 
+ **storage** | **String**| The document storage. | [optional] 
+ **folder** | **String**| The document folder. | [optional] 
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **post_split_document**
 > SplitResultResponse post_split_document(name, opts)
 
@@ -8921,6 +8948,32 @@ Name | Type | Description  | Notes
 
 
 
+# **put_signature_field**
+> SignatureFieldResponse put_signature_field(name, field_name, field, opts)
+
+Replace document signature field.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The document name. | 
+ **field_name** | **String**| The field name. | 
+ **field** | [**SignatureField**](SignatureField.md)| The field. | 
+ **storage** | **String**| The document storage. | [optional] 
+ **folder** | **String**| The document folder. | [optional] 
+
+### Return type
+
+[**SignatureFieldResponse**](SignatureFieldResponse.md)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **put_sound_annotation**
 > SoundAnnotationResponse put_sound_annotation(name, annotation_id, annotation, opts)
 

data/lib/aspose_pdf_cloud/api/pdf_api.rb

@@ -18879,6 +18879,83 @@ module AsposePdfCloud
       return data, status_code, headers
     end
 
+    # Add document signature field.
+    # 
+    # @param name The document name.
+    # @param field The field.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder The document folder.
+    # @return [AsposeResponse]
+    def post_signature_field(name, field, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = post_signature_field_with_http_info(name, field, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = post_signature_field_with_http_info(name, field, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Add document signature field.
+    # 
+    # @param name The document name.
+    # @param field The field.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder The document folder.
+    # @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
+    def post_signature_field_with_http_info(name, field, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.post_signature_field ..."
+      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_signature_field"
+      end
+      # verify the required parameter 'field' is set
+      if @api_client.config.client_side_validation && field.nil?
+        fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.post_signature_field"
+      end
+      # resource path
+      local_var_path = "/pdf/{name}/fields/signature".sub('{' + 'name' + '}', name.to_s)
+
+      # query parameters
+      query_params = {}
+      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)
+      post_body = @api_client.object_to_http_body(field)
+      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_signature_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Split document to parts.
     # 
     # @param name Document name.
@@ -26849,6 +26926,89 @@ module AsposePdfCloud
       return data, status_code, headers
     end
 
+    # Replace document signature field.
+    # 
+    # @param name The document name.
+    # @param field_name The field name.
+    # @param field The field.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder The document folder.
+    # @return [SignatureFieldResponse]
+    def put_signature_field(name, field_name, field, opts = {})
+      @api_client.request_token_if_needed
+      data, _status_code, _headers = put_signature_field_with_http_info(name, field_name, field, opts)
+      rescue ApiError => error
+        if error.code == 401
+          @api_client.request_token_if_needed
+          data, _status_code, _headers = put_signature_field_with_http_info(name, field_name, field, opts)
+        else
+          raise
+        end
+      return data
+    end
+
+    # Replace document signature field.
+    # 
+    # @param name The document name.
+    # @param field_name The field name.
+    # @param field The field.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage The document storage.
+    # @option opts [String] :folder The document folder.
+    # @return [Array<(SignatureFieldResponse, Fixnum, Hash)>] SignatureFieldResponse data, response status code and response headers
+    def put_signature_field_with_http_info(name, field_name, field, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PdfApi.put_signature_field ..."
+      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_signature_field"
+      end
+      # verify the required parameter 'field_name' is set
+      if @api_client.config.client_side_validation && field_name.nil?
+        fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.put_signature_field"
+      end
+      # verify the required parameter 'field' is set
+      if @api_client.config.client_side_validation && field.nil?
+        fail ArgumentError, "Missing the required parameter 'field' when calling PdfApi.put_signature_field"
+      end
+      # resource path
+      local_var_path = "/pdf/{name}/fields/signature/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
+
+      # query parameters
+      query_params = {}
+      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)
+      post_body = @api_client.object_to_http_body(field)
+      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 => 'SignatureFieldResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PdfApi#put_signature_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Replace document sound annotation
     # 
     # @param name The document name.

data/lib/aspose_pdf_cloud/version.rb

@@ -20,5 +20,5 @@ SOFTWARE.
 =end
 
 module AsposePdfCloud
-  VERSION = "19.12.0"
+  VERSION = "20.1.0"
 end

data/test/pdf_tests.rb

@@ -3862,7 +3862,7 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed flatten document.')
   end
 
-  def test_get_document_gignature_fields
+  def test_get_document_sigignature_fields
     file_name = 'adbe.x509.rsa_sha1.valid.pdf'
     upload_file(file_name)
 
@@ -3874,7 +3874,7 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to read document signature fields.')
   end
 
-  def test_get_page_gignature_fields
+  def test_get_page_sigignature_fields
     file_name = 'adbe.x509.rsa_sha1.valid.pdf'
     upload_file(file_name)
 
@@ -3887,7 +3887,75 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to read page signature fields.')
   end
 
-  def test_get_gignature_field
+  def test_post_sigignature_field
+    file_name = '4pages.pdf'
+    upload_file(file_name)
+
+    signature_name = '33226.p12'
+    upload_file(signature_name)
+
+    signature = Signature.new
+    signature.authority = 'Sergey Smal'
+    signature.contact = 'test@mail.ru'
+    signature.date = '08/01/2012 12:15:00.000 PM'
+    signature.form_field_name = 'Signature1'
+    signature.location = 'Ukraine'
+    signature.password = 'sIikZSmz'
+    signature.rectangle = Rectangle.new({:LLX => 100, :LLY => 100, :URX => 500, :URY => 200})
+    signature.signature_path = @temp_folder + '/' + signature_name
+    signature.signature_type = SignatureType::PKCS7
+    signature.visible = true
+    signature.show_properties = false
+
+    field = SignatureField.new
+    field.partial_name = 'sign1'
+    field.rect = Rectangle.new({:LLX => 100, :LLY => 100, :URX => 500, :URY => 200})
+    field.signature = signature
+    field.page_index = 1
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.post_signature_field(file_name, field, opts)
+    assert(response, 'Failed to create signature field.')
+  end
+
+  def test_put_sigignature_field
+    file_name = 'adbe.x509.rsa_sha1.valid.pdf'
+    upload_file(file_name)
+
+    signature_name = '33226.p12'
+    upload_file(signature_name)
+
+    signature = Signature.new
+    signature.authority = 'Sergey Smal'
+    signature.contact = 'test@mail.ru'
+    signature.date = '08/01/2012 12:15:00.000 PM'
+    signature.form_field_name = 'Signature1'
+    signature.location = 'Ukraine'
+    signature.password = 'sIikZSmz'
+    signature.rectangle = Rectangle.new({:LLX => 100, :LLY => 100, :URX => 500, :URY => 200})
+    signature.signature_path = @temp_folder + '/' + signature_name
+    signature.signature_type = SignatureType::PKCS7
+    signature.visible = true
+    signature.show_properties = false
+
+    field = SignatureField.new
+    field.partial_name = 'sign1'
+    field.rect = Rectangle.new({:LLX => 100, :LLY => 100, :URX => 500, :URY => 200})
+    field.signature = signature
+    field.page_index = 1
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.put_signature_field(file_name, 'Signature1', field, opts)
+    assert(response, 'Failed to update signature field.')
+  end
+
+  def test_get_sigignature_field
     file_name = 'adbe.x509.rsa_sha1.valid.pdf'
     upload_file(file_name)
 
@@ -3900,6 +3968,9 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to read signature field.')
   end
 
+
+
+
   def test_get_document_text_box_fields
     file_name = 'FormDataTextBox.pdf'
     upload_file(file_name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspose_pdf_cloud
 version: !ruby/object:Gem::Version
-  version: 19.12.0
+  version: 20.1.0
 platform: ruby
 authors:
 - Aspose PDF Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json