aspose_pdf_cloud 19.7.0 → 19.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -4
- data/docs/DocMDPAccessPermissionType.md +16 -0
- data/docs/FormField.md +26 -0
- data/docs/PdfApi.md +155 -0
- data/docs/Signature.md +3 -0
- data/docs/SignatureCustomAppearance.md +20 -0
- data/docs/SignatureField.md +27 -0
- data/docs/SignatureFieldResponse.md +11 -0
- data/docs/SignatureFields.md +10 -0
- data/docs/SignatureFieldsResponse.md +11 -0
- data/docs/TimestampSettings.md +10 -0
- data/lib/aspose_pdf_cloud.rb +8 -0
- data/lib/aspose_pdf_cloud/api/pdf_api.rb +479 -8
- data/lib/aspose_pdf_cloud/models/doc_mdp_access_permission_type.rb +45 -0
- data/lib/aspose_pdf_cloud/models/form_field.rb +383 -0
- data/lib/aspose_pdf_cloud/models/signature.rb +34 -4
- data/lib/aspose_pdf_cloud/models/signature_custom_appearance.rb +329 -0
- data/lib/aspose_pdf_cloud/models/signature_field.rb +393 -0
- data/lib/aspose_pdf_cloud/models/signature_field_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/signature_fields.rb +213 -0
- data/lib/aspose_pdf_cloud/models/signature_fields_response.rb +224 -0
- data/lib/aspose_pdf_cloud/models/timestamp_settings.rb +209 -0
- data/lib/aspose_pdf_cloud/version.rb +1 -1
- data/test/pdf_tests.rb +96 -0
- data/test_data/33226.p12 +0 -0
- data/test_data/adbe.x509.rsa_sha1.valid.pdf +0 -0
- data/test_data/mixed.md +14 -0
- metadata +21 -2
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::SignatureFieldResponse
|
2
|
+
Represents response containing single signature field object
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**field** | [**SignatureField**](SignatureField.md) | Signature field object | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::SignatureFields
|
2
|
+
Object representing a list of signature fields.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**links** | [**Array<Link>**](Link.md) | Link to the document. | [optional]
|
8
|
+
**list** | [**Array<SignatureField>**](SignatureField.md) | List of signature fields. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# AsposePdfCloud::SignatureFieldsResponse
|
2
|
+
Represents response containing multiple signature field objects
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**code** | **Integer** | Response status code. |
|
8
|
+
**status** | **String** | Response status. | [optional]
|
9
|
+
**fields** | [**SignatureFields**](SignatureFields.md) | Signature fields object | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# AsposePdfCloud::TimestampSettings
|
2
|
+
Represents the ocsp settings using during signing process.
|
3
|
+
|
4
|
+
## Properties
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**server_url** | **String** | Gets/sets the timestamp server url. | [optional]
|
8
|
+
**basic_auth_credentials** | **String** | Gets/sets the basic authentication credentials, Username and password are combined into a string "username:password". | [optional]
|
9
|
+
|
10
|
+
|
data/lib/aspose_pdf_cloud.rb
CHANGED
@@ -45,6 +45,7 @@ require_relative 'aspose_pdf_cloud/models/compression_type'
|
|
45
45
|
require_relative 'aspose_pdf_cloud/models/crypto_algorithm'
|
46
46
|
require_relative 'aspose_pdf_cloud/models/disc_usage'
|
47
47
|
require_relative 'aspose_pdf_cloud/models/doc_format'
|
48
|
+
require_relative 'aspose_pdf_cloud/models/doc_mdp_access_permission_type'
|
48
49
|
require_relative 'aspose_pdf_cloud/models/doc_recognition_mode'
|
49
50
|
require_relative 'aspose_pdf_cloud/models/document_privilege'
|
50
51
|
require_relative 'aspose_pdf_cloud/models/epub_recognition_mode'
|
@@ -95,6 +96,7 @@ require_relative 'aspose_pdf_cloud/models/row_recognized'
|
|
95
96
|
require_relative 'aspose_pdf_cloud/models/segment'
|
96
97
|
require_relative 'aspose_pdf_cloud/models/shape_type'
|
97
98
|
require_relative 'aspose_pdf_cloud/models/signature'
|
99
|
+
require_relative 'aspose_pdf_cloud/models/signature_custom_appearance'
|
98
100
|
require_relative 'aspose_pdf_cloud/models/signature_type'
|
99
101
|
require_relative 'aspose_pdf_cloud/models/sound_encoding'
|
100
102
|
require_relative 'aspose_pdf_cloud/models/sound_icon'
|
@@ -114,6 +116,7 @@ require_relative 'aspose_pdf_cloud/models/text_replace'
|
|
114
116
|
require_relative 'aspose_pdf_cloud/models/text_replace_list_request'
|
115
117
|
require_relative 'aspose_pdf_cloud/models/text_state'
|
116
118
|
require_relative 'aspose_pdf_cloud/models/text_style'
|
119
|
+
require_relative 'aspose_pdf_cloud/models/timestamp_settings'
|
117
120
|
require_relative 'aspose_pdf_cloud/models/vertical_alignment'
|
118
121
|
require_relative 'aspose_pdf_cloud/models/word_count'
|
119
122
|
require_relative 'aspose_pdf_cloud/models/wrap_mode'
|
@@ -150,6 +153,7 @@ require_relative 'aspose_pdf_cloud/models/file_attachment_annotation_response'
|
|
150
153
|
require_relative 'aspose_pdf_cloud/models/file_attachment_annotations'
|
151
154
|
require_relative 'aspose_pdf_cloud/models/file_attachment_annotations_response'
|
152
155
|
require_relative 'aspose_pdf_cloud/models/file_version'
|
156
|
+
require_relative 'aspose_pdf_cloud/models/form_field'
|
153
157
|
require_relative 'aspose_pdf_cloud/models/free_text_annotation_response'
|
154
158
|
require_relative 'aspose_pdf_cloud/models/free_text_annotations'
|
155
159
|
require_relative 'aspose_pdf_cloud/models/free_text_annotations_response'
|
@@ -190,6 +194,9 @@ require_relative 'aspose_pdf_cloud/models/redaction_annotations_response'
|
|
190
194
|
require_relative 'aspose_pdf_cloud/models/screen_annotation_response'
|
191
195
|
require_relative 'aspose_pdf_cloud/models/screen_annotations'
|
192
196
|
require_relative 'aspose_pdf_cloud/models/screen_annotations_response'
|
197
|
+
require_relative 'aspose_pdf_cloud/models/signature_field_response'
|
198
|
+
require_relative 'aspose_pdf_cloud/models/signature_fields'
|
199
|
+
require_relative 'aspose_pdf_cloud/models/signature_fields_response'
|
193
200
|
require_relative 'aspose_pdf_cloud/models/signature_verify_response'
|
194
201
|
require_relative 'aspose_pdf_cloud/models/sound_annotation_response'
|
195
202
|
require_relative 'aspose_pdf_cloud/models/sound_annotations'
|
@@ -237,6 +244,7 @@ require_relative 'aspose_pdf_cloud/models/pdf_page_stamp'
|
|
237
244
|
require_relative 'aspose_pdf_cloud/models/popup_annotation'
|
238
245
|
require_relative 'aspose_pdf_cloud/models/redaction_annotation'
|
239
246
|
require_relative 'aspose_pdf_cloud/models/screen_annotation'
|
247
|
+
require_relative 'aspose_pdf_cloud/models/signature_field'
|
240
248
|
require_relative 'aspose_pdf_cloud/models/text_footer'
|
241
249
|
require_relative 'aspose_pdf_cloud/models/text_header'
|
242
250
|
require_relative 'aspose_pdf_cloud/models/text_stamp'
|
@@ -3824,6 +3824,78 @@ module AsposePdfCloud
|
|
3824
3824
|
return data, status_code, headers
|
3825
3825
|
end
|
3826
3826
|
|
3827
|
+
# Read document signature fields.
|
3828
|
+
#
|
3829
|
+
# @param name The document name.
|
3830
|
+
# @param [Hash] opts the optional parameters
|
3831
|
+
# @option opts [String] :storage The document storage.
|
3832
|
+
# @option opts [String] :folder The document folder.
|
3833
|
+
# @return [SignatureFieldsResponse]
|
3834
|
+
def get_document_signature_fields(name, opts = {})
|
3835
|
+
@api_client.request_token_if_needed
|
3836
|
+
data, _status_code, _headers = get_document_signature_fields_with_http_info(name, opts)
|
3837
|
+
rescue ApiError => error
|
3838
|
+
if error.code == 401
|
3839
|
+
@api_client.request_token_if_needed
|
3840
|
+
data, _status_code, _headers = get_document_signature_fields_with_http_info(name, opts)
|
3841
|
+
else
|
3842
|
+
raise
|
3843
|
+
end
|
3844
|
+
return data
|
3845
|
+
end
|
3846
|
+
|
3847
|
+
# Read document signature fields.
|
3848
|
+
#
|
3849
|
+
# @param name The document name.
|
3850
|
+
# @param [Hash] opts the optional parameters
|
3851
|
+
# @option opts [String] :storage The document storage.
|
3852
|
+
# @option opts [String] :folder The document folder.
|
3853
|
+
# @return [Array<(SignatureFieldsResponse, Fixnum, Hash)>] SignatureFieldsResponse data, response status code and response headers
|
3854
|
+
def get_document_signature_fields_with_http_info(name, opts = {})
|
3855
|
+
if @api_client.config.debugging
|
3856
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_document_signature_fields ..."
|
3857
|
+
end
|
3858
|
+
# verify the required parameter 'name' is set
|
3859
|
+
if @api_client.config.client_side_validation && name.nil?
|
3860
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_document_signature_fields"
|
3861
|
+
end
|
3862
|
+
# resource path
|
3863
|
+
local_var_path = "/pdf/{name}/fields/signature".sub('{' + 'name' + '}', name.to_s)
|
3864
|
+
|
3865
|
+
# query parameters
|
3866
|
+
query_params = {}
|
3867
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
3868
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
3869
|
+
|
3870
|
+
# header parameters
|
3871
|
+
header_params = {}
|
3872
|
+
# HTTP header 'Accept' (if needed)
|
3873
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3874
|
+
# HTTP header 'Content-Type'
|
3875
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
3876
|
+
|
3877
|
+
# form parameters
|
3878
|
+
form_params = {}
|
3879
|
+
# Fix header in file
|
3880
|
+
post_body = nil
|
3881
|
+
|
3882
|
+
# http body (model)
|
3883
|
+
# Fix header in file
|
3884
|
+
# post_body = nil
|
3885
|
+
auth_names = ['JWT']
|
3886
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
3887
|
+
:header_params => header_params,
|
3888
|
+
:query_params => query_params,
|
3889
|
+
:form_params => form_params,
|
3890
|
+
:body => post_body,
|
3891
|
+
:auth_names => auth_names,
|
3892
|
+
:return_type => 'SignatureFieldsResponse')
|
3893
|
+
if @api_client.config.debugging
|
3894
|
+
@api_client.config.logger.debug "API called: PdfApi#get_document_signature_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3895
|
+
end
|
3896
|
+
return data, status_code, headers
|
3897
|
+
end
|
3898
|
+
|
3827
3899
|
# Read document sound annotations.
|
3828
3900
|
#
|
3829
3901
|
# @param name The document name.
|
@@ -6563,6 +6635,76 @@ module AsposePdfCloud
|
|
6563
6635
|
return data, status_code, headers
|
6564
6636
|
end
|
6565
6637
|
|
6638
|
+
# Convert MD file (located on storage) to PDF format and return resulting file in response.
|
6639
|
+
#
|
6640
|
+
# @param src_path Full source filename (ex. /folder1/folder2/template.md)
|
6641
|
+
# @param [Hash] opts the optional parameters
|
6642
|
+
# @option opts [String] :storage The document storage.
|
6643
|
+
# @return [File]
|
6644
|
+
def get_markdown_in_storage_to_pdf(src_path, opts = {})
|
6645
|
+
@api_client.request_token_if_needed
|
6646
|
+
data, _status_code, _headers = get_markdown_in_storage_to_pdf_with_http_info(src_path, opts)
|
6647
|
+
rescue ApiError => error
|
6648
|
+
if error.code == 401
|
6649
|
+
@api_client.request_token_if_needed
|
6650
|
+
data, _status_code, _headers = get_markdown_in_storage_to_pdf_with_http_info(src_path, opts)
|
6651
|
+
else
|
6652
|
+
raise
|
6653
|
+
end
|
6654
|
+
return data
|
6655
|
+
end
|
6656
|
+
|
6657
|
+
# Convert MD file (located on storage) to PDF format and return resulting file in response.
|
6658
|
+
#
|
6659
|
+
# @param src_path Full source filename (ex. /folder1/folder2/template.md)
|
6660
|
+
# @param [Hash] opts the optional parameters
|
6661
|
+
# @option opts [String] :storage The document storage.
|
6662
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
6663
|
+
def get_markdown_in_storage_to_pdf_with_http_info(src_path, opts = {})
|
6664
|
+
if @api_client.config.debugging
|
6665
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_markdown_in_storage_to_pdf ..."
|
6666
|
+
end
|
6667
|
+
# verify the required parameter 'src_path' is set
|
6668
|
+
if @api_client.config.client_side_validation && src_path.nil?
|
6669
|
+
fail ArgumentError, "Missing the required parameter 'src_path' when calling PdfApi.get_markdown_in_storage_to_pdf"
|
6670
|
+
end
|
6671
|
+
# resource path
|
6672
|
+
local_var_path = "/pdf/create/markdown"
|
6673
|
+
|
6674
|
+
# query parameters
|
6675
|
+
query_params = {}
|
6676
|
+
query_params[:'srcPath'] = src_path
|
6677
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
6678
|
+
|
6679
|
+
# header parameters
|
6680
|
+
header_params = {}
|
6681
|
+
# HTTP header 'Accept' (if needed)
|
6682
|
+
header_params['Accept'] = @api_client.select_header_accept(['multipart/form-data'])
|
6683
|
+
# HTTP header 'Content-Type'
|
6684
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
6685
|
+
|
6686
|
+
# form parameters
|
6687
|
+
form_params = {}
|
6688
|
+
# Fix header in file
|
6689
|
+
post_body = nil
|
6690
|
+
|
6691
|
+
# http body (model)
|
6692
|
+
# Fix header in file
|
6693
|
+
# post_body = nil
|
6694
|
+
auth_names = ['JWT']
|
6695
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
6696
|
+
:header_params => header_params,
|
6697
|
+
:query_params => query_params,
|
6698
|
+
:form_params => form_params,
|
6699
|
+
:body => post_body,
|
6700
|
+
:auth_names => auth_names,
|
6701
|
+
:return_type => 'File')
|
6702
|
+
if @api_client.config.debugging
|
6703
|
+
@api_client.config.logger.debug "API called: PdfApi#get_markdown_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
6704
|
+
end
|
6705
|
+
return data, status_code, headers
|
6706
|
+
end
|
6707
|
+
|
6566
6708
|
# Convert MHT file (located on storage) to PDF format and return resulting file in response.
|
6567
6709
|
#
|
6568
6710
|
# @param src_path Full source filename (ex. /folder1/folder2/template.mht)
|
@@ -8547,6 +8689,84 @@ module AsposePdfCloud
|
|
8547
8689
|
return data, status_code, headers
|
8548
8690
|
end
|
8549
8691
|
|
8692
|
+
# Read document page signature fields.
|
8693
|
+
#
|
8694
|
+
# @param name The document name.
|
8695
|
+
# @param page_number The page number.
|
8696
|
+
# @param [Hash] opts the optional parameters
|
8697
|
+
# @option opts [String] :storage The document storage.
|
8698
|
+
# @option opts [String] :folder The document folder.
|
8699
|
+
# @return [SignatureFieldsResponse]
|
8700
|
+
def get_page_signature_fields(name, page_number, opts = {})
|
8701
|
+
@api_client.request_token_if_needed
|
8702
|
+
data, _status_code, _headers = get_page_signature_fields_with_http_info(name, page_number, opts)
|
8703
|
+
rescue ApiError => error
|
8704
|
+
if error.code == 401
|
8705
|
+
@api_client.request_token_if_needed
|
8706
|
+
data, _status_code, _headers = get_page_signature_fields_with_http_info(name, page_number, opts)
|
8707
|
+
else
|
8708
|
+
raise
|
8709
|
+
end
|
8710
|
+
return data
|
8711
|
+
end
|
8712
|
+
|
8713
|
+
# Read document page signature fields.
|
8714
|
+
#
|
8715
|
+
# @param name The document name.
|
8716
|
+
# @param page_number The page number.
|
8717
|
+
# @param [Hash] opts the optional parameters
|
8718
|
+
# @option opts [String] :storage The document storage.
|
8719
|
+
# @option opts [String] :folder The document folder.
|
8720
|
+
# @return [Array<(SignatureFieldsResponse, Fixnum, Hash)>] SignatureFieldsResponse data, response status code and response headers
|
8721
|
+
def get_page_signature_fields_with_http_info(name, page_number, opts = {})
|
8722
|
+
if @api_client.config.debugging
|
8723
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_page_signature_fields ..."
|
8724
|
+
end
|
8725
|
+
# verify the required parameter 'name' is set
|
8726
|
+
if @api_client.config.client_side_validation && name.nil?
|
8727
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_page_signature_fields"
|
8728
|
+
end
|
8729
|
+
# verify the required parameter 'page_number' is set
|
8730
|
+
if @api_client.config.client_side_validation && page_number.nil?
|
8731
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.get_page_signature_fields"
|
8732
|
+
end
|
8733
|
+
# resource path
|
8734
|
+
local_var_path = "/pdf/{name}/page/{pageNumber}/fields/signature".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
|
8735
|
+
|
8736
|
+
# query parameters
|
8737
|
+
query_params = {}
|
8738
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
8739
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
8740
|
+
|
8741
|
+
# header parameters
|
8742
|
+
header_params = {}
|
8743
|
+
# HTTP header 'Accept' (if needed)
|
8744
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8745
|
+
# HTTP header 'Content-Type'
|
8746
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
8747
|
+
|
8748
|
+
# form parameters
|
8749
|
+
form_params = {}
|
8750
|
+
# Fix header in file
|
8751
|
+
post_body = nil
|
8752
|
+
|
8753
|
+
# http body (model)
|
8754
|
+
# Fix header in file
|
8755
|
+
# post_body = nil
|
8756
|
+
auth_names = ['JWT']
|
8757
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
8758
|
+
:header_params => header_params,
|
8759
|
+
:query_params => query_params,
|
8760
|
+
:form_params => form_params,
|
8761
|
+
:body => post_body,
|
8762
|
+
:auth_names => auth_names,
|
8763
|
+
:return_type => 'SignatureFieldsResponse')
|
8764
|
+
if @api_client.config.debugging
|
8765
|
+
@api_client.config.logger.debug "API called: PdfApi#get_page_signature_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8766
|
+
end
|
8767
|
+
return data, status_code, headers
|
8768
|
+
end
|
8769
|
+
|
8550
8770
|
# Read document page sound annotations.
|
8551
8771
|
#
|
8552
8772
|
# @param name The document name.
|
@@ -9173,7 +9393,7 @@ module AsposePdfCloud
|
|
9173
9393
|
query_params[:'LLY'] = lly
|
9174
9394
|
query_params[:'URX'] = urx
|
9175
9395
|
query_params[:'URY'] = ury
|
9176
|
-
query_params[:'format'] = @api_client.build_collection_param(opts[:'format'], :
|
9396
|
+
query_params[:'format'] = @api_client.build_collection_param(opts[:'format'], :csv) if !opts[:'format'].nil?
|
9177
9397
|
query_params[:'regex'] = opts[:'regex'] if !opts[:'regex'].nil?
|
9178
9398
|
query_params[:'splitRects'] = opts[:'split_rects'] if !opts[:'split_rects'].nil?
|
9179
9399
|
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
@@ -9820,7 +10040,7 @@ module AsposePdfCloud
|
|
9820
10040
|
query_params[:'useZOrder'] = opts[:'use_z_order'] if !opts[:'use_z_order'].nil?
|
9821
10041
|
query_params[:'antialiasingProcessing'] = opts[:'antialiasing_processing'] if !opts[:'antialiasing_processing'].nil?
|
9822
10042
|
query_params[:'cssClassNamesPrefix'] = opts[:'css_class_names_prefix'] if !opts[:'css_class_names_prefix'].nil?
|
9823
|
-
query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :
|
10043
|
+
query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :csv) if !opts[:'explicit_list_of_saved_pages'].nil?
|
9824
10044
|
query_params[:'fontEncodingStrategy'] = opts[:'font_encoding_strategy'] if !opts[:'font_encoding_strategy'].nil?
|
9825
10045
|
query_params[:'fontSavingMode'] = opts[:'font_saving_mode'] if !opts[:'font_saving_mode'].nil?
|
9826
10046
|
query_params[:'htmlMarkupGenerationMode'] = opts[:'html_markup_generation_mode'] if !opts[:'html_markup_generation_mode'].nil?
|
@@ -11225,6 +11445,84 @@ module AsposePdfCloud
|
|
11225
11445
|
return data, status_code, headers
|
11226
11446
|
end
|
11227
11447
|
|
11448
|
+
# Read document signature field by name.
|
11449
|
+
#
|
11450
|
+
# @param name The document name.
|
11451
|
+
# @param field_name The field name.
|
11452
|
+
# @param [Hash] opts the optional parameters
|
11453
|
+
# @option opts [String] :storage The document storage.
|
11454
|
+
# @option opts [String] :folder The document folder.
|
11455
|
+
# @return [SignatureFieldResponse]
|
11456
|
+
def get_signature_field(name, field_name, opts = {})
|
11457
|
+
@api_client.request_token_if_needed
|
11458
|
+
data, _status_code, _headers = get_signature_field_with_http_info(name, field_name, opts)
|
11459
|
+
rescue ApiError => error
|
11460
|
+
if error.code == 401
|
11461
|
+
@api_client.request_token_if_needed
|
11462
|
+
data, _status_code, _headers = get_signature_field_with_http_info(name, field_name, opts)
|
11463
|
+
else
|
11464
|
+
raise
|
11465
|
+
end
|
11466
|
+
return data
|
11467
|
+
end
|
11468
|
+
|
11469
|
+
# Read document signature field by name.
|
11470
|
+
#
|
11471
|
+
# @param name The document name.
|
11472
|
+
# @param field_name The field name.
|
11473
|
+
# @param [Hash] opts the optional parameters
|
11474
|
+
# @option opts [String] :storage The document storage.
|
11475
|
+
# @option opts [String] :folder The document folder.
|
11476
|
+
# @return [Array<(SignatureFieldResponse, Fixnum, Hash)>] SignatureFieldResponse data, response status code and response headers
|
11477
|
+
def get_signature_field_with_http_info(name, field_name, opts = {})
|
11478
|
+
if @api_client.config.debugging
|
11479
|
+
@api_client.config.logger.debug "Calling API: PdfApi.get_signature_field ..."
|
11480
|
+
end
|
11481
|
+
# verify the required parameter 'name' is set
|
11482
|
+
if @api_client.config.client_side_validation && name.nil?
|
11483
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.get_signature_field"
|
11484
|
+
end
|
11485
|
+
# verify the required parameter 'field_name' is set
|
11486
|
+
if @api_client.config.client_side_validation && field_name.nil?
|
11487
|
+
fail ArgumentError, "Missing the required parameter 'field_name' when calling PdfApi.get_signature_field"
|
11488
|
+
end
|
11489
|
+
# resource path
|
11490
|
+
local_var_path = "/pdf/{name}/fields/signature/{fieldName}".sub('{' + 'name' + '}', name.to_s).sub('{' + 'fieldName' + '}', field_name.to_s)
|
11491
|
+
|
11492
|
+
# query parameters
|
11493
|
+
query_params = {}
|
11494
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
11495
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
11496
|
+
|
11497
|
+
# header parameters
|
11498
|
+
header_params = {}
|
11499
|
+
# HTTP header 'Accept' (if needed)
|
11500
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11501
|
+
# HTTP header 'Content-Type'
|
11502
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
11503
|
+
|
11504
|
+
# form parameters
|
11505
|
+
form_params = {}
|
11506
|
+
# Fix header in file
|
11507
|
+
post_body = nil
|
11508
|
+
|
11509
|
+
# http body (model)
|
11510
|
+
# Fix header in file
|
11511
|
+
# post_body = nil
|
11512
|
+
auth_names = ['JWT']
|
11513
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
11514
|
+
:header_params => header_params,
|
11515
|
+
:query_params => query_params,
|
11516
|
+
:form_params => form_params,
|
11517
|
+
:body => post_body,
|
11518
|
+
:auth_names => auth_names,
|
11519
|
+
:return_type => 'SignatureFieldResponse')
|
11520
|
+
if @api_client.config.debugging
|
11521
|
+
@api_client.config.logger.debug "API called: PdfApi#get_signature_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
11522
|
+
end
|
11523
|
+
return data, status_code, headers
|
11524
|
+
end
|
11525
|
+
|
11228
11526
|
# Read document page sound annotation by ID.
|
11229
11527
|
#
|
11230
11528
|
# @param name The document name.
|
@@ -12017,7 +12315,7 @@ module AsposePdfCloud
|
|
12017
12315
|
query_params[:'LLY'] = lly
|
12018
12316
|
query_params[:'URX'] = urx
|
12019
12317
|
query_params[:'URY'] = ury
|
12020
|
-
query_params[:'format'] = @api_client.build_collection_param(opts[:'format'], :
|
12318
|
+
query_params[:'format'] = @api_client.build_collection_param(opts[:'format'], :csv) if !opts[:'format'].nil?
|
12021
12319
|
query_params[:'regex'] = opts[:'regex'] if !opts[:'regex'].nil?
|
12022
12320
|
query_params[:'splitRects'] = opts[:'split_rects'] if !opts[:'split_rects'].nil?
|
12023
12321
|
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
@@ -13951,7 +14249,7 @@ module AsposePdfCloud
|
|
13951
14249
|
query_params[:'userPassword'] = user_password
|
13952
14250
|
query_params[:'ownerPassword'] = owner_password
|
13953
14251
|
query_params[:'cryptoAlgorithm'] = crypto_algorithm
|
13954
|
-
query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :
|
14252
|
+
query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :csv) if !opts[:'permissions_flags'].nil?
|
13955
14253
|
query_params[:'usePdf20'] = opts[:'use_pdf20'] if !opts[:'use_pdf20'].nil?
|
13956
14254
|
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
13957
14255
|
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
@@ -14652,6 +14950,100 @@ module AsposePdfCloud
|
|
14652
14950
|
return data, status_code, headers
|
14653
14951
|
end
|
14654
14952
|
|
14953
|
+
# Certify document page.
|
14954
|
+
#
|
14955
|
+
# @param name The document name.
|
14956
|
+
# @param page_number The page number.
|
14957
|
+
# @param sign Signature object containing signature data.
|
14958
|
+
# @param doc_mdp_access_permission_type The access permissions granted for this document.
|
14959
|
+
# @param [Hash] opts the optional parameters
|
14960
|
+
# @option opts [String] :storage The document storage.
|
14961
|
+
# @option opts [String] :folder The document folder.
|
14962
|
+
# @return [AsposeResponse]
|
14963
|
+
def post_page_certify(name, page_number, sign, doc_mdp_access_permission_type, opts = {})
|
14964
|
+
@api_client.request_token_if_needed
|
14965
|
+
data, _status_code, _headers = post_page_certify_with_http_info(name, page_number, sign, doc_mdp_access_permission_type, opts)
|
14966
|
+
rescue ApiError => error
|
14967
|
+
if error.code == 401
|
14968
|
+
@api_client.request_token_if_needed
|
14969
|
+
data, _status_code, _headers = post_page_certify_with_http_info(name, page_number, sign, doc_mdp_access_permission_type, opts)
|
14970
|
+
else
|
14971
|
+
raise
|
14972
|
+
end
|
14973
|
+
return data
|
14974
|
+
end
|
14975
|
+
|
14976
|
+
# Certify document page.
|
14977
|
+
#
|
14978
|
+
# @param name The document name.
|
14979
|
+
# @param page_number The page number.
|
14980
|
+
# @param sign Signature object containing signature data.
|
14981
|
+
# @param doc_mdp_access_permission_type The access permissions granted for this document.
|
14982
|
+
# @param [Hash] opts the optional parameters
|
14983
|
+
# @option opts [String] :storage The document storage.
|
14984
|
+
# @option opts [String] :folder The document folder.
|
14985
|
+
# @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
|
14986
|
+
def post_page_certify_with_http_info(name, page_number, sign, doc_mdp_access_permission_type, opts = {})
|
14987
|
+
if @api_client.config.debugging
|
14988
|
+
@api_client.config.logger.debug "Calling API: PdfApi.post_page_certify ..."
|
14989
|
+
end
|
14990
|
+
# verify the required parameter 'name' is set
|
14991
|
+
if @api_client.config.client_side_validation && name.nil?
|
14992
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.post_page_certify"
|
14993
|
+
end
|
14994
|
+
# verify the required parameter 'page_number' is set
|
14995
|
+
if @api_client.config.client_side_validation && page_number.nil?
|
14996
|
+
fail ArgumentError, "Missing the required parameter 'page_number' when calling PdfApi.post_page_certify"
|
14997
|
+
end
|
14998
|
+
# verify the required parameter 'sign' is set
|
14999
|
+
if @api_client.config.client_side_validation && sign.nil?
|
15000
|
+
fail ArgumentError, "Missing the required parameter 'sign' when calling PdfApi.post_page_certify"
|
15001
|
+
end
|
15002
|
+
# verify the required parameter 'doc_mdp_access_permission_type' is set
|
15003
|
+
if @api_client.config.client_side_validation && doc_mdp_access_permission_type.nil?
|
15004
|
+
fail ArgumentError, "Missing the required parameter 'doc_mdp_access_permission_type' when calling PdfApi.post_page_certify"
|
15005
|
+
end
|
15006
|
+
# verify enum value
|
15007
|
+
if @api_client.config.client_side_validation && !['NoChanges', 'FillingInForms', 'AnnotationModification'].include?(doc_mdp_access_permission_type)
|
15008
|
+
fail ArgumentError, "invalid value for 'doc_mdp_access_permission_type', must be one of NoChanges, FillingInForms, AnnotationModification"
|
15009
|
+
end
|
15010
|
+
# resource path
|
15011
|
+
local_var_path = "/pdf/{name}/pages/{pageNumber}/certify".sub('{' + 'name' + '}', name.to_s).sub('{' + 'pageNumber' + '}', page_number.to_s)
|
15012
|
+
|
15013
|
+
# query parameters
|
15014
|
+
query_params = {}
|
15015
|
+
query_params[:'docMdpAccessPermissionType'] = doc_mdp_access_permission_type
|
15016
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
15017
|
+
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
15018
|
+
|
15019
|
+
# header parameters
|
15020
|
+
header_params = {}
|
15021
|
+
# HTTP header 'Accept' (if needed)
|
15022
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
15023
|
+
# HTTP header 'Content-Type'
|
15024
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
15025
|
+
|
15026
|
+
# form parameters
|
15027
|
+
form_params = {}
|
15028
|
+
# Fix header in file
|
15029
|
+
post_body = nil
|
15030
|
+
|
15031
|
+
# http body (model)
|
15032
|
+
post_body = @api_client.object_to_http_body(sign)
|
15033
|
+
auth_names = ['JWT']
|
15034
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
15035
|
+
:header_params => header_params,
|
15036
|
+
:query_params => query_params,
|
15037
|
+
:form_params => form_params,
|
15038
|
+
:body => post_body,
|
15039
|
+
:auth_names => auth_names,
|
15040
|
+
:return_type => 'AsposeResponse')
|
15041
|
+
if @api_client.config.debugging
|
15042
|
+
@api_client.config.logger.debug "API called: PdfApi#post_page_certify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
15043
|
+
end
|
15044
|
+
return data, status_code, headers
|
15045
|
+
end
|
15046
|
+
|
14655
15047
|
# Add document page circle annotations.
|
14656
15048
|
#
|
14657
15049
|
# @param name The document name.
|
@@ -17171,7 +17563,7 @@ module AsposePdfCloud
|
|
17171
17563
|
query_params = {}
|
17172
17564
|
query_params[:'startPage'] = opts[:'start_page'] if !opts[:'start_page'].nil?
|
17173
17565
|
query_params[:'endPage'] = opts[:'end_page'] if !opts[:'end_page'].nil?
|
17174
|
-
query_params[:'annotationTypes'] = @api_client.build_collection_param(opts[:'annotation_types'], :
|
17566
|
+
query_params[:'annotationTypes'] = @api_client.build_collection_param(opts[:'annotation_types'], :csv) if !opts[:'annotation_types'].nil?
|
17175
17567
|
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
17176
17568
|
query_params[:'folder'] = opts[:'folder'] if !opts[:'folder'].nil?
|
17177
17569
|
|
@@ -17771,7 +18163,7 @@ module AsposePdfCloud
|
|
17771
18163
|
query_params[:'userPassword'] = user_password
|
17772
18164
|
query_params[:'ownerPassword'] = owner_password
|
17773
18165
|
query_params[:'cryptoAlgorithm'] = crypto_algorithm
|
17774
|
-
query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :
|
18166
|
+
query_params[:'permissionsFlags'] = @api_client.build_collection_param(opts[:'permissions_flags'], :csv) if !opts[:'permissions_flags'].nil?
|
17775
18167
|
query_params[:'usePdf20'] = opts[:'use_pdf20'] if !opts[:'use_pdf20'].nil?
|
17776
18168
|
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
17777
18169
|
|
@@ -19965,6 +20357,85 @@ module AsposePdfCloud
|
|
19965
20357
|
return data, status_code, headers
|
19966
20358
|
end
|
19967
20359
|
|
20360
|
+
# Convert MD file (located on storage) to PDF format and upload resulting file to storage.
|
20361
|
+
#
|
20362
|
+
# @param name The document name.
|
20363
|
+
# @param src_path Full source filename (ex. /folder1/folder2/template.md)
|
20364
|
+
# @param [Hash] opts the optional parameters
|
20365
|
+
# @option opts [String] :storage The document storage.
|
20366
|
+
# @option opts [String] :dst_folder The destination document folder.
|
20367
|
+
# @return [AsposeResponse]
|
20368
|
+
def put_markdown_in_storage_to_pdf(name, src_path, opts = {})
|
20369
|
+
@api_client.request_token_if_needed
|
20370
|
+
data, _status_code, _headers = put_markdown_in_storage_to_pdf_with_http_info(name, src_path, opts)
|
20371
|
+
rescue ApiError => error
|
20372
|
+
if error.code == 401
|
20373
|
+
@api_client.request_token_if_needed
|
20374
|
+
data, _status_code, _headers = put_markdown_in_storage_to_pdf_with_http_info(name, src_path, opts)
|
20375
|
+
else
|
20376
|
+
raise
|
20377
|
+
end
|
20378
|
+
return data
|
20379
|
+
end
|
20380
|
+
|
20381
|
+
# Convert MD file (located on storage) to PDF format and upload resulting file to storage.
|
20382
|
+
#
|
20383
|
+
# @param name The document name.
|
20384
|
+
# @param src_path Full source filename (ex. /folder1/folder2/template.md)
|
20385
|
+
# @param [Hash] opts the optional parameters
|
20386
|
+
# @option opts [String] :storage The document storage.
|
20387
|
+
# @option opts [String] :dst_folder The destination document folder.
|
20388
|
+
# @return [Array<(AsposeResponse, Fixnum, Hash)>] AsposeResponse data, response status code and response headers
|
20389
|
+
def put_markdown_in_storage_to_pdf_with_http_info(name, src_path, opts = {})
|
20390
|
+
if @api_client.config.debugging
|
20391
|
+
@api_client.config.logger.debug "Calling API: PdfApi.put_markdown_in_storage_to_pdf ..."
|
20392
|
+
end
|
20393
|
+
# verify the required parameter 'name' is set
|
20394
|
+
if @api_client.config.client_side_validation && name.nil?
|
20395
|
+
fail ArgumentError, "Missing the required parameter 'name' when calling PdfApi.put_markdown_in_storage_to_pdf"
|
20396
|
+
end
|
20397
|
+
# verify the required parameter 'src_path' is set
|
20398
|
+
if @api_client.config.client_side_validation && src_path.nil?
|
20399
|
+
fail ArgumentError, "Missing the required parameter 'src_path' when calling PdfApi.put_markdown_in_storage_to_pdf"
|
20400
|
+
end
|
20401
|
+
# resource path
|
20402
|
+
local_var_path = "/pdf/{name}/create/markdown".sub('{' + 'name' + '}', name.to_s)
|
20403
|
+
|
20404
|
+
# query parameters
|
20405
|
+
query_params = {}
|
20406
|
+
query_params[:'srcPath'] = src_path
|
20407
|
+
query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
|
20408
|
+
query_params[:'dstFolder'] = opts[:'dst_folder'] if !opts[:'dst_folder'].nil?
|
20409
|
+
|
20410
|
+
# header parameters
|
20411
|
+
header_params = {}
|
20412
|
+
# HTTP header 'Accept' (if needed)
|
20413
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
20414
|
+
# HTTP header 'Content-Type'
|
20415
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
20416
|
+
|
20417
|
+
# form parameters
|
20418
|
+
form_params = {}
|
20419
|
+
# Fix header in file
|
20420
|
+
post_body = nil
|
20421
|
+
|
20422
|
+
# http body (model)
|
20423
|
+
# Fix header in file
|
20424
|
+
# post_body = nil
|
20425
|
+
auth_names = ['JWT']
|
20426
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
20427
|
+
:header_params => header_params,
|
20428
|
+
:query_params => query_params,
|
20429
|
+
:form_params => form_params,
|
20430
|
+
:body => post_body,
|
20431
|
+
:auth_names => auth_names,
|
20432
|
+
:return_type => 'AsposeResponse')
|
20433
|
+
if @api_client.config.debugging
|
20434
|
+
@api_client.config.logger.debug "API called: PdfApi#put_markdown_in_storage_to_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
20435
|
+
end
|
20436
|
+
return data, status_code, headers
|
20437
|
+
end
|
20438
|
+
|
19968
20439
|
# Merge a list of documents.
|
19969
20440
|
#
|
19970
20441
|
# @param name Resulting documen name.
|
@@ -21231,7 +21702,7 @@ module AsposePdfCloud
|
|
21231
21702
|
query_params[:'useZOrder'] = opts[:'use_z_order'] if !opts[:'use_z_order'].nil?
|
21232
21703
|
query_params[:'antialiasingProcessing'] = opts[:'antialiasing_processing'] if !opts[:'antialiasing_processing'].nil?
|
21233
21704
|
query_params[:'cssClassNamesPrefix'] = opts[:'css_class_names_prefix'] if !opts[:'css_class_names_prefix'].nil?
|
21234
|
-
query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :
|
21705
|
+
query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :csv) if !opts[:'explicit_list_of_saved_pages'].nil?
|
21235
21706
|
query_params[:'fontEncodingStrategy'] = opts[:'font_encoding_strategy'] if !opts[:'font_encoding_strategy'].nil?
|
21236
21707
|
query_params[:'fontSavingMode'] = opts[:'font_saving_mode'] if !opts[:'font_saving_mode'].nil?
|
21237
21708
|
query_params[:'htmlMarkupGenerationMode'] = opts[:'html_markup_generation_mode'] if !opts[:'html_markup_generation_mode'].nil?
|
@@ -22451,7 +22922,7 @@ module AsposePdfCloud
|
|
22451
22922
|
query_params[:'useZOrder'] = opts[:'use_z_order'] if !opts[:'use_z_order'].nil?
|
22452
22923
|
query_params[:'antialiasingProcessing'] = opts[:'antialiasing_processing'] if !opts[:'antialiasing_processing'].nil?
|
22453
22924
|
query_params[:'cssClassNamesPrefix'] = opts[:'css_class_names_prefix'] if !opts[:'css_class_names_prefix'].nil?
|
22454
|
-
query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :
|
22925
|
+
query_params[:'explicitListOfSavedPages'] = @api_client.build_collection_param(opts[:'explicit_list_of_saved_pages'], :csv) if !opts[:'explicit_list_of_saved_pages'].nil?
|
22455
22926
|
query_params[:'fontEncodingStrategy'] = opts[:'font_encoding_strategy'] if !opts[:'font_encoding_strategy'].nil?
|
22456
22927
|
query_params[:'fontSavingMode'] = opts[:'font_saving_mode'] if !opts[:'font_saving_mode'].nil?
|
22457
22928
|
query_params[:'htmlMarkupGenerationMode'] = opts[:'html_markup_generation_mode'] if !opts[:'html_markup_generation_mode'].nil?
|