cloudmersive-convert-api-client 1.5.0 → 1.5.1
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 +5 -4
- data/docs/EditPdfApi.md +68 -5
- data/lib/cloudmersive-convert-api-client/api/edit_pdf_api.rb +79 -6
- data/lib/cloudmersive-convert-api-client/version.rb +1 -1
- data/spec/api/edit_pdf_api_spec.rb +16 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 73922ed46694ebd0ee0297e00b4b722276ebfefa49be9abefce2414659e84036
|
4
|
+
data.tar.gz: 350fe8da3fdad773fe3c84bbb12f0eeeb55d5a7c2697879df93731feb9dce5e3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bc58380a66d94dbe507d027775a2d312b3d569456c6b212746f9078abffb7c1dd31fd41f122a8e544ef350e50838a24ab5e8b7321e851495977b6d384fd966de
|
7
|
+
data.tar.gz: de37f3295017abc4a03790b4202237de74e5e67a9503e83ade7a0fb8d1b2a3792fb58e276d1eea15aba68ea16717ad31adf7c8590c10f20fbf32c6052e6e1715
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Convert API lets you effortlessly convert file formats and types.
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 1.5.
|
10
|
+
- Package version: 1.5.1
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-convert-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-convert-api-client-1.5.
|
26
|
+
gem install ./cloudmersive-convert-api-client-1.5.1.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.5.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-convert-api-client-1.5.1.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-convert-api-client', '~> 1.5.
|
34
|
+
gem 'cloudmersive-convert-api-client', '~> 1.5.1'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -153,6 +153,7 @@ Class | Method | HTTP request | Description
|
|
153
153
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_styles**](docs/EditDocumentApi.md#edit_document_xlsx_get_styles) | **POST** /convert/edit/xlsx/get-styles | Get styles from a Excel XLSX spreadsheet, worksheet
|
154
154
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_get_worksheets**](docs/EditDocumentApi.md#edit_document_xlsx_get_worksheets) | **POST** /convert/edit/xlsx/get-worksheets | Get worksheets from a Excel XLSX spreadsheet
|
155
155
|
*CloudmersiveConvertApiClient::EditDocumentApi* | [**edit_document_xlsx_insert_worksheet**](docs/EditDocumentApi.md#edit_document_xlsx_insert_worksheet) | **POST** /convert/edit/xlsx/insert-worksheet | Insert a new worksheet into an Excel XLSX spreadsheet
|
156
|
+
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_decrypt**](docs/EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
156
157
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_delete_pages**](docs/EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document
|
157
158
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_encrypt**](docs/EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
158
159
|
*CloudmersiveConvertApiClient::EditPdfApi* | [**edit_pdf_get_form_fields**](docs/EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
|
data/docs/EditPdfApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**edit_pdf_decrypt**](EditPdfApi.md#edit_pdf_decrypt) | **POST** /convert/edit/pdf/decrypt | Decrypt and password-protect a PDF
|
7
8
|
[**edit_pdf_delete_pages**](EditPdfApi.md#edit_pdf_delete_pages) | **POST** /convert/edit/pdf/pages/delete | Remove / delete pages from a PDF document
|
8
9
|
[**edit_pdf_encrypt**](EditPdfApi.md#edit_pdf_encrypt) | **POST** /convert/edit/pdf/encrypt | Encrypt and password-protect a PDF
|
9
10
|
[**edit_pdf_get_form_fields**](EditPdfApi.md#edit_pdf_get_form_fields) | **POST** /convert/edit/pdf/form/get-fields | Gets PDF Form fields and values
|
@@ -16,6 +17,63 @@ Method | HTTP request | Description
|
|
16
17
|
[**edit_pdf_watermark_text**](EditPdfApi.md#edit_pdf_watermark_text) | **POST** /convert/edit/pdf/watermark/text | Add a text watermark to a PDF
|
17
18
|
|
18
19
|
|
20
|
+
# **edit_pdf_decrypt**
|
21
|
+
> String edit_pdf_decrypt(password, input_file)
|
22
|
+
|
23
|
+
Decrypt and password-protect a PDF
|
24
|
+
|
25
|
+
Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.
|
26
|
+
|
27
|
+
### Example
|
28
|
+
```ruby
|
29
|
+
# load the gem
|
30
|
+
require 'cloudmersive-convert-api-client'
|
31
|
+
# setup authorization
|
32
|
+
CloudmersiveConvertApiClient.configure do |config|
|
33
|
+
# Configure API key authorization: Apikey
|
34
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
37
|
+
end
|
38
|
+
|
39
|
+
api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
40
|
+
|
41
|
+
password = "password_example" # String | Valid password for the PDF file
|
42
|
+
|
43
|
+
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
44
|
+
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Decrypt and password-protect a PDF
|
48
|
+
result = api_instance.edit_pdf_decrypt(password, input_file)
|
49
|
+
p result
|
50
|
+
rescue CloudmersiveConvertApiClient::ApiError => e
|
51
|
+
puts "Exception when calling EditPdfApi->edit_pdf_decrypt: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
Name | Type | Description | Notes
|
58
|
+
------------- | ------------- | ------------- | -------------
|
59
|
+
**password** | **String**| Valid password for the PDF file |
|
60
|
+
**input_file** | **File**| Input file to perform the operation on. |
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
**String**
|
65
|
+
|
66
|
+
### Authorization
|
67
|
+
|
68
|
+
[Apikey](../README.md#Apikey)
|
69
|
+
|
70
|
+
### HTTP request headers
|
71
|
+
|
72
|
+
- **Content-Type**: multipart/form-data
|
73
|
+
- **Accept**: application/octet-stream
|
74
|
+
|
75
|
+
|
76
|
+
|
19
77
|
# **edit_pdf_delete_pages**
|
20
78
|
> String edit_pdf_delete_pages(input_file, page_start, page_end)
|
21
79
|
|
@@ -101,7 +159,8 @@ input_file = File.new("/path/to/file.txt") # File | Input file to perform the op
|
|
101
159
|
|
102
160
|
opts = {
|
103
161
|
user_password: "user_password_example", # String | Password of a user (reader) of the PDF file
|
104
|
-
owner_password: "owner_password_example" # String | Password of a owner (creator/editor) of the PDF file
|
162
|
+
owner_password: "owner_password_example", # String | Password of a owner (creator/editor) of the PDF file
|
163
|
+
encryption_key_length: "encryption_key_length_example" # String | Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
105
164
|
}
|
106
165
|
|
107
166
|
begin
|
@@ -120,6 +179,7 @@ Name | Type | Description | Notes
|
|
120
179
|
**input_file** | **File**| Input file to perform the operation on. |
|
121
180
|
**user_password** | **String**| Password of a user (reader) of the PDF file | [optional]
|
122
181
|
**owner_password** | **String**| Password of a owner (creator/editor) of the PDF file | [optional]
|
182
|
+
**encryption_key_length** | **String**| Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256. | [optional]
|
123
183
|
|
124
184
|
### Return type
|
125
185
|
|
@@ -473,7 +533,7 @@ Name | Type | Description | Notes
|
|
473
533
|
|
474
534
|
|
475
535
|
# **edit_pdf_set_permissions**
|
476
|
-
> String edit_pdf_set_permissions(owner_password, input_file, opts)
|
536
|
+
> String edit_pdf_set_permissions(owner_password, user_password, input_file, opts)
|
477
537
|
|
478
538
|
Encrypt, password-protect and set restricted permissions on a PDF
|
479
539
|
|
@@ -495,10 +555,12 @@ api_instance = CloudmersiveConvertApiClient::EditPdfApi.new
|
|
495
555
|
|
496
556
|
owner_password = "owner_password_example" # String | Password of a owner (creator/editor) of the PDF file (required)
|
497
557
|
|
558
|
+
user_password = "user_password_example" # String | Password of a user (reader) of the PDF file (optional)
|
559
|
+
|
498
560
|
input_file = File.new("/path/to/file.txt") # File | Input file to perform the operation on.
|
499
561
|
|
500
562
|
opts = {
|
501
|
-
|
563
|
+
encryption_key_length: "encryption_key_length_example", # String | Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
502
564
|
allow_printing: true, # BOOLEAN | Set to false to disable printing through DRM. Default is true.
|
503
565
|
allow_document_assembly: true, # BOOLEAN | Set to false to disable document assembly through DRM. Default is true.
|
504
566
|
allow_content_extraction: true, # BOOLEAN | Set to false to disable copying/extracting content out of the PDF through DRM. Default is true.
|
@@ -510,7 +572,7 @@ opts = {
|
|
510
572
|
|
511
573
|
begin
|
512
574
|
#Encrypt, password-protect and set restricted permissions on a PDF
|
513
|
-
result = api_instance.edit_pdf_set_permissions(owner_password, input_file, opts)
|
575
|
+
result = api_instance.edit_pdf_set_permissions(owner_password, user_password, input_file, opts)
|
514
576
|
p result
|
515
577
|
rescue CloudmersiveConvertApiClient::ApiError => e
|
516
578
|
puts "Exception when calling EditPdfApi->edit_pdf_set_permissions: #{e}"
|
@@ -522,8 +584,9 @@ end
|
|
522
584
|
Name | Type | Description | Notes
|
523
585
|
------------- | ------------- | ------------- | -------------
|
524
586
|
**owner_password** | **String**| Password of a owner (creator/editor) of the PDF file (required) |
|
587
|
+
**user_password** | **String**| Password of a user (reader) of the PDF file (optional) |
|
525
588
|
**input_file** | **File**| Input file to perform the operation on. |
|
526
|
-
**
|
589
|
+
**encryption_key_length** | **String**| Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256. | [optional]
|
527
590
|
**allow_printing** | **BOOLEAN**| Set to false to disable printing through DRM. Default is true. | [optional]
|
528
591
|
**allow_document_assembly** | **BOOLEAN**| Set to false to disable document assembly through DRM. Default is true. | [optional]
|
529
592
|
**allow_content_extraction** | **BOOLEAN**| Set to false to disable copying/extracting content out of the PDF through DRM. Default is true. | [optional]
|
@@ -20,6 +20,69 @@ module CloudmersiveConvertApiClient
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
|
23
|
+
# Decrypt and password-protect a PDF
|
24
|
+
# Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.
|
25
|
+
# @param password Valid password for the PDF file
|
26
|
+
# @param input_file Input file to perform the operation on.
|
27
|
+
# @param [Hash] opts the optional parameters
|
28
|
+
# @return [String]
|
29
|
+
def edit_pdf_decrypt(password, input_file, opts = {})
|
30
|
+
data, _status_code, _headers = edit_pdf_decrypt_with_http_info(password, input_file, opts)
|
31
|
+
return data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Decrypt and password-protect a PDF
|
35
|
+
# Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.
|
36
|
+
# @param password Valid password for the PDF file
|
37
|
+
# @param input_file Input file to perform the operation on.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
40
|
+
def edit_pdf_decrypt_with_http_info(password, input_file, opts = {})
|
41
|
+
if @api_client.config.debugging
|
42
|
+
@api_client.config.logger.debug "Calling API: EditPdfApi.edit_pdf_decrypt ..."
|
43
|
+
end
|
44
|
+
# verify the required parameter 'password' is set
|
45
|
+
if @api_client.config.client_side_validation && password.nil?
|
46
|
+
fail ArgumentError, "Missing the required parameter 'password' when calling EditPdfApi.edit_pdf_decrypt"
|
47
|
+
end
|
48
|
+
# verify the required parameter 'input_file' is set
|
49
|
+
if @api_client.config.client_side_validation && input_file.nil?
|
50
|
+
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditPdfApi.edit_pdf_decrypt"
|
51
|
+
end
|
52
|
+
# resource path
|
53
|
+
local_var_path = "/convert/edit/pdf/decrypt"
|
54
|
+
|
55
|
+
# query parameters
|
56
|
+
query_params = {}
|
57
|
+
|
58
|
+
# header parameters
|
59
|
+
header_params = {}
|
60
|
+
# HTTP header 'Accept' (if needed)
|
61
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
62
|
+
# HTTP header 'Content-Type'
|
63
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
64
|
+
header_params[:'password'] = password
|
65
|
+
|
66
|
+
# form parameters
|
67
|
+
form_params = {}
|
68
|
+
form_params["inputFile"] = input_file
|
69
|
+
|
70
|
+
# http body (model)
|
71
|
+
post_body = nil
|
72
|
+
auth_names = ['Apikey']
|
73
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
74
|
+
:header_params => header_params,
|
75
|
+
:query_params => query_params,
|
76
|
+
:form_params => form_params,
|
77
|
+
:body => post_body,
|
78
|
+
:auth_names => auth_names,
|
79
|
+
:return_type => 'String')
|
80
|
+
if @api_client.config.debugging
|
81
|
+
@api_client.config.logger.debug "API called: EditPdfApi#edit_pdf_decrypt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
82
|
+
end
|
83
|
+
return data, status_code, headers
|
84
|
+
end
|
85
|
+
|
23
86
|
# Remove / delete pages from a PDF document
|
24
87
|
# Remove one or more pages from a PDF document
|
25
88
|
# @param input_file Input file to perform the operation on.
|
@@ -96,6 +159,7 @@ module CloudmersiveConvertApiClient
|
|
96
159
|
# @param [Hash] opts the optional parameters
|
97
160
|
# @option opts [String] :user_password Password of a user (reader) of the PDF file
|
98
161
|
# @option opts [String] :owner_password Password of a owner (creator/editor) of the PDF file
|
162
|
+
# @option opts [String] :encryption_key_length Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
99
163
|
# @return [String]
|
100
164
|
def edit_pdf_encrypt(input_file, opts = {})
|
101
165
|
data, _status_code, _headers = edit_pdf_encrypt_with_http_info(input_file, opts)
|
@@ -108,6 +172,7 @@ module CloudmersiveConvertApiClient
|
|
108
172
|
# @param [Hash] opts the optional parameters
|
109
173
|
# @option opts [String] :user_password Password of a user (reader) of the PDF file
|
110
174
|
# @option opts [String] :owner_password Password of a owner (creator/editor) of the PDF file
|
175
|
+
# @option opts [String] :encryption_key_length Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
111
176
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
112
177
|
def edit_pdf_encrypt_with_http_info(input_file, opts = {})
|
113
178
|
if @api_client.config.debugging
|
@@ -131,6 +196,7 @@ module CloudmersiveConvertApiClient
|
|
131
196
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
132
197
|
header_params[:'userPassword'] = opts[:'user_password'] if !opts[:'user_password'].nil?
|
133
198
|
header_params[:'ownerPassword'] = opts[:'owner_password'] if !opts[:'owner_password'].nil?
|
199
|
+
header_params[:'encryptionKeyLength'] = opts[:'encryption_key_length'] if !opts[:'encryption_key_length'].nil?
|
134
200
|
|
135
201
|
# form parameters
|
136
202
|
form_params = {}
|
@@ -517,9 +583,10 @@ module CloudmersiveConvertApiClient
|
|
517
583
|
# Encrypt, password-protect and set restricted permissions on a PDF
|
518
584
|
# Encrypt a PDF document with a password, and set permissions on the PDF. Set an owner password to control owner (editor/creator) permissions [required], and set a user (reader) password to control the viewer of the PDF [optional]. Set the reader password to null to omit the password. Restrict or allow printing, copying content, document assembly, editing (read-only), form filling, modification of annotations, and degraded printing through document Digital Rights Management (DRM).
|
519
585
|
# @param owner_password Password of a owner (creator/editor) of the PDF file (required)
|
586
|
+
# @param user_password Password of a user (reader) of the PDF file (optional)
|
520
587
|
# @param input_file Input file to perform the operation on.
|
521
588
|
# @param [Hash] opts the optional parameters
|
522
|
-
# @option opts [String] :
|
589
|
+
# @option opts [String] :encryption_key_length Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
523
590
|
# @option opts [BOOLEAN] :allow_printing Set to false to disable printing through DRM. Default is true.
|
524
591
|
# @option opts [BOOLEAN] :allow_document_assembly Set to false to disable document assembly through DRM. Default is true.
|
525
592
|
# @option opts [BOOLEAN] :allow_content_extraction Set to false to disable copying/extracting content out of the PDF through DRM. Default is true.
|
@@ -528,17 +595,18 @@ module CloudmersiveConvertApiClient
|
|
528
595
|
# @option opts [BOOLEAN] :allow_annotations Set to false to disable annotations and editing of annotations in the PDF through DRM. Default is true.
|
529
596
|
# @option opts [BOOLEAN] :allow_degraded_printing Set to false to disable degraded printing of the PDF through DRM. Default is true.
|
530
597
|
# @return [String]
|
531
|
-
def edit_pdf_set_permissions(owner_password, input_file, opts = {})
|
532
|
-
data, _status_code, _headers = edit_pdf_set_permissions_with_http_info(owner_password, input_file, opts)
|
598
|
+
def edit_pdf_set_permissions(owner_password, user_password, input_file, opts = {})
|
599
|
+
data, _status_code, _headers = edit_pdf_set_permissions_with_http_info(owner_password, user_password, input_file, opts)
|
533
600
|
return data
|
534
601
|
end
|
535
602
|
|
536
603
|
# Encrypt, password-protect and set restricted permissions on a PDF
|
537
604
|
# Encrypt a PDF document with a password, and set permissions on the PDF. Set an owner password to control owner (editor/creator) permissions [required], and set a user (reader) password to control the viewer of the PDF [optional]. Set the reader password to null to omit the password. Restrict or allow printing, copying content, document assembly, editing (read-only), form filling, modification of annotations, and degraded printing through document Digital Rights Management (DRM).
|
538
605
|
# @param owner_password Password of a owner (creator/editor) of the PDF file (required)
|
606
|
+
# @param user_password Password of a user (reader) of the PDF file (optional)
|
539
607
|
# @param input_file Input file to perform the operation on.
|
540
608
|
# @param [Hash] opts the optional parameters
|
541
|
-
# @option opts [String] :
|
609
|
+
# @option opts [String] :encryption_key_length Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
542
610
|
# @option opts [BOOLEAN] :allow_printing Set to false to disable printing through DRM. Default is true.
|
543
611
|
# @option opts [BOOLEAN] :allow_document_assembly Set to false to disable document assembly through DRM. Default is true.
|
544
612
|
# @option opts [BOOLEAN] :allow_content_extraction Set to false to disable copying/extracting content out of the PDF through DRM. Default is true.
|
@@ -547,7 +615,7 @@ module CloudmersiveConvertApiClient
|
|
547
615
|
# @option opts [BOOLEAN] :allow_annotations Set to false to disable annotations and editing of annotations in the PDF through DRM. Default is true.
|
548
616
|
# @option opts [BOOLEAN] :allow_degraded_printing Set to false to disable degraded printing of the PDF through DRM. Default is true.
|
549
617
|
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
550
|
-
def edit_pdf_set_permissions_with_http_info(owner_password, input_file, opts = {})
|
618
|
+
def edit_pdf_set_permissions_with_http_info(owner_password, user_password, input_file, opts = {})
|
551
619
|
if @api_client.config.debugging
|
552
620
|
@api_client.config.logger.debug "Calling API: EditPdfApi.edit_pdf_set_permissions ..."
|
553
621
|
end
|
@@ -555,6 +623,10 @@ module CloudmersiveConvertApiClient
|
|
555
623
|
if @api_client.config.client_side_validation && owner_password.nil?
|
556
624
|
fail ArgumentError, "Missing the required parameter 'owner_password' when calling EditPdfApi.edit_pdf_set_permissions"
|
557
625
|
end
|
626
|
+
# verify the required parameter 'user_password' is set
|
627
|
+
if @api_client.config.client_side_validation && user_password.nil?
|
628
|
+
fail ArgumentError, "Missing the required parameter 'user_password' when calling EditPdfApi.edit_pdf_set_permissions"
|
629
|
+
end
|
558
630
|
# verify the required parameter 'input_file' is set
|
559
631
|
if @api_client.config.client_side_validation && input_file.nil?
|
560
632
|
fail ArgumentError, "Missing the required parameter 'input_file' when calling EditPdfApi.edit_pdf_set_permissions"
|
@@ -572,7 +644,8 @@ module CloudmersiveConvertApiClient
|
|
572
644
|
# HTTP header 'Content-Type'
|
573
645
|
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
574
646
|
header_params[:'ownerPassword'] = owner_password
|
575
|
-
header_params[:'userPassword'] =
|
647
|
+
header_params[:'userPassword'] = user_password
|
648
|
+
header_params[:'encryptionKeyLength'] = opts[:'encryption_key_length'] if !opts[:'encryption_key_length'].nil?
|
576
649
|
header_params[:'allowPrinting'] = opts[:'allow_printing'] if !opts[:'allow_printing'].nil?
|
577
650
|
header_params[:'allowDocumentAssembly'] = opts[:'allow_document_assembly'] if !opts[:'allow_document_assembly'].nil?
|
578
651
|
header_params[:'allowContentExtraction'] = opts[:'allow_content_extraction'] if !opts[:'allow_content_extraction'].nil?
|
@@ -32,6 +32,19 @@ describe 'EditPdfApi' do
|
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
35
|
+
# unit tests for edit_pdf_decrypt
|
36
|
+
# Decrypt and password-protect a PDF
|
37
|
+
# Decrypt a PDF document with a password. Decrypted PDF will no longer require a password to open.
|
38
|
+
# @param password Valid password for the PDF file
|
39
|
+
# @param input_file Input file to perform the operation on.
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [String]
|
42
|
+
describe 'edit_pdf_decrypt test' do
|
43
|
+
it "should work" do
|
44
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
35
48
|
# unit tests for edit_pdf_delete_pages
|
36
49
|
# Remove / delete pages from a PDF document
|
37
50
|
# Remove one or more pages from a PDF document
|
@@ -53,6 +66,7 @@ describe 'EditPdfApi' do
|
|
53
66
|
# @param [Hash] opts the optional parameters
|
54
67
|
# @option opts [String] :user_password Password of a user (reader) of the PDF file
|
55
68
|
# @option opts [String] :owner_password Password of a owner (creator/editor) of the PDF file
|
69
|
+
# @option opts [String] :encryption_key_length Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
56
70
|
# @return [String]
|
57
71
|
describe 'edit_pdf_encrypt test' do
|
58
72
|
it "should work" do
|
@@ -140,9 +154,10 @@ describe 'EditPdfApi' do
|
|
140
154
|
# Encrypt, password-protect and set restricted permissions on a PDF
|
141
155
|
# Encrypt a PDF document with a password, and set permissions on the PDF. Set an owner password to control owner (editor/creator) permissions [required], and set a user (reader) password to control the viewer of the PDF [optional]. Set the reader password to null to omit the password. Restrict or allow printing, copying content, document assembly, editing (read-only), form filling, modification of annotations, and degraded printing through document Digital Rights Management (DRM).
|
142
156
|
# @param owner_password Password of a owner (creator/editor) of the PDF file (required)
|
157
|
+
# @param user_password Password of a user (reader) of the PDF file (optional)
|
143
158
|
# @param input_file Input file to perform the operation on.
|
144
159
|
# @param [Hash] opts the optional parameters
|
145
|
-
# @option opts [String] :
|
160
|
+
# @option opts [String] :encryption_key_length Possible values are \"128\" (128-bit RC4 encryption) and \"256\" (256-bit AES encryption). Default is 256.
|
146
161
|
# @option opts [BOOLEAN] :allow_printing Set to false to disable printing through DRM. Default is true.
|
147
162
|
# @option opts [BOOLEAN] :allow_document_assembly Set to false to disable document assembly through DRM. Default is true.
|
148
163
|
# @option opts [BOOLEAN] :allow_content_extraction Set to false to disable copying/extracting content out of the PDF through DRM. Default is true.
|