aspose_words_cloud 24.8.0 → 24.10.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/lib/aspose_words_cloud/api/words_api.rb +260 -0
- data/lib/aspose_words_cloud/models/azw3_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/digital_signature_details.rb +218 -0
- data/lib/aspose_words_cloud/models/epub_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/html_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/mhtml_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/open_xps_save_options_data.rb +14 -1
- data/lib/aspose_words_cloud/models/pdf_save_options_data.rb +13 -1
- data/lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb +8 -1
- data/lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb +8 -1
- data/lib/aspose_words_cloud/models/requests/get_signatures_online_request.rb +179 -0
- data/lib/aspose_words_cloud/models/requests/get_signatures_request.rb +178 -0
- data/lib/aspose_words_cloud/models/requests/remove_all_signatures_online_request.rb +186 -0
- data/lib/aspose_words_cloud/models/requests/remove_all_signatures_request.rb +185 -0
- data/lib/aspose_words_cloud/models/requests/sign_document_online_request.rb +208 -0
- data/lib/aspose_words_cloud/models/requests/sign_document_request.rb +207 -0
- data/lib/aspose_words_cloud/models/responses/remove_all_signatures_online_response.rb +47 -0
- data/lib/aspose_words_cloud/models/responses/sign_document_online_response.rb +47 -0
- data/lib/aspose_words_cloud/models/sign_options.rb +254 -0
- data/lib/aspose_words_cloud/models/signature.rb +267 -0
- data/lib/aspose_words_cloud/models/signature_collection_response.rb +236 -0
- data/lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/xaml_flow_save_options_data.rb +15 -1
- data/lib/aspose_words_cloud/models/xps_save_options_data.rb +14 -1
- data/lib/aspose_words_cloud/version.rb +1 -1
- data/lib/aspose_words_cloud.rb +10 -0
- metadata +14 -2
@@ -0,0 +1,178 @@
|
|
1
|
+
# ------------------------------------------------------------------------------------
|
2
|
+
# <copyright company="Aspose" file="get_signatures_request.rb">
|
3
|
+
# Copyright (c) 2024 Aspose.Words for Cloud
|
4
|
+
# </copyright>
|
5
|
+
# <summary>
|
6
|
+
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
7
|
+
# of this software and associated documentation files (the "Software"), to deal
|
8
|
+
# in the Software without restriction, including without limitation the rights
|
9
|
+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10
|
+
# copies of the Software, and to permit persons to whom the Software is
|
11
|
+
# furnished to do so, subject to the following conditions:
|
12
|
+
#
|
13
|
+
# The above copyright notice and this permission notice shall be included in all
|
14
|
+
# copies or substantial portions of the Software.
|
15
|
+
#
|
16
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18
|
+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
19
|
+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20
|
+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21
|
+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
22
|
+
# SOFTWARE.
|
23
|
+
# </summary>
|
24
|
+
# ------------------------------------------------------------------------------------
|
25
|
+
|
26
|
+
module AsposeWordsCloud
|
27
|
+
|
28
|
+
#
|
29
|
+
# Request model for get_signatures operation.
|
30
|
+
#
|
31
|
+
class GetSignaturesRequest
|
32
|
+
# The filename of the Word document.
|
33
|
+
attr_accessor :name
|
34
|
+
|
35
|
+
# Original document folder.
|
36
|
+
attr_accessor :folder
|
37
|
+
|
38
|
+
# Original document storage.
|
39
|
+
attr_accessor :storage
|
40
|
+
|
41
|
+
# Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
42
|
+
attr_accessor :load_encoding
|
43
|
+
|
44
|
+
# Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
|
45
|
+
attr_accessor :password
|
46
|
+
|
47
|
+
# Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
|
48
|
+
attr_accessor :encrypted_password
|
49
|
+
|
50
|
+
# The value indicates whether OpenType support is on.
|
51
|
+
attr_accessor :open_type_support
|
52
|
+
|
53
|
+
#
|
54
|
+
# Initializes a new instance.
|
55
|
+
# @param name The filename of the Word document.
|
56
|
+
# @param folder Original document folder.
|
57
|
+
# @param storage Original document storage.
|
58
|
+
# @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
59
|
+
# @param password Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
|
60
|
+
# @param encrypted_password Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
|
61
|
+
# @param open_type_support The value indicates whether OpenType support is on.
|
62
|
+
|
63
|
+
def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil)
|
64
|
+
self.name = name
|
65
|
+
self.folder = folder
|
66
|
+
self.storage = storage
|
67
|
+
self.load_encoding = load_encoding
|
68
|
+
self.password = password
|
69
|
+
self.encrypted_password = encrypted_password
|
70
|
+
self.open_type_support = open_type_support
|
71
|
+
end
|
72
|
+
|
73
|
+
# Creating batch part from request
|
74
|
+
def to_batch_part(api_client, requestId, parentRequestId = nil)
|
75
|
+
# verify the required parameter 'name' is set
|
76
|
+
raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_signatures' if api_client.config.client_side_validation && self.name.nil?
|
77
|
+
|
78
|
+
# resource path
|
79
|
+
local_var_path = '/words/{name}/signatures'[7..-1]
|
80
|
+
local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
|
81
|
+
local_var_path = local_var_path.sub('//', '/')
|
82
|
+
|
83
|
+
# query parameters
|
84
|
+
query_params = {}
|
85
|
+
query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
|
86
|
+
query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
|
87
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
88
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
89
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
90
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
91
|
+
|
92
|
+
if query_params
|
93
|
+
query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
|
94
|
+
end
|
95
|
+
|
96
|
+
header_params = {}
|
97
|
+
header_params['RequestId'] = requestId
|
98
|
+
|
99
|
+
if parentRequestId != nil
|
100
|
+
header_params['DependsOn'] = parentRequestId
|
101
|
+
end
|
102
|
+
|
103
|
+
# form parameters
|
104
|
+
form_params = []
|
105
|
+
files_content = []
|
106
|
+
|
107
|
+
# http body (model)
|
108
|
+
body = api_client.build_request_body_batch(header_params, form_params, files_content)
|
109
|
+
part = ""
|
110
|
+
part.concat("GET".force_encoding('UTF-8'))
|
111
|
+
part.concat(" ".force_encoding('UTF-8'))
|
112
|
+
part.concat(local_var_path.force_encoding('UTF-8'))
|
113
|
+
part.concat(" \r\n".force_encoding('UTF-8'))
|
114
|
+
|
115
|
+
header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
|
116
|
+
part.concat("\r\n".force_encoding('UTF-8'))
|
117
|
+
if body
|
118
|
+
if body.is_a?(Hash)
|
119
|
+
body.each do |key, value|
|
120
|
+
part.concat(value, "\r\n")
|
121
|
+
end
|
122
|
+
else
|
123
|
+
part.concat(body)
|
124
|
+
end
|
125
|
+
end
|
126
|
+
part
|
127
|
+
end
|
128
|
+
|
129
|
+
def create_http_request(api_client)
|
130
|
+
# verify the required parameter 'name' is set
|
131
|
+
raise ArgumentError, 'Missing the required parameter name when calling WordsApi.get_signatures' if api_client.config.client_side_validation && self.name.nil?
|
132
|
+
|
133
|
+
# resource path
|
134
|
+
local_var_path = '/words/{name}/signatures'[1..-1]
|
135
|
+
local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
|
136
|
+
local_var_path = local_var_path.sub('//', '/')
|
137
|
+
|
138
|
+
# query parameters
|
139
|
+
query_params = {}
|
140
|
+
query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
|
141
|
+
query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
|
142
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
143
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
144
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
145
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
146
|
+
|
147
|
+
# header parameters
|
148
|
+
header_params = {}
|
149
|
+
# HTTP header 'Content-Type'
|
150
|
+
header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])
|
151
|
+
|
152
|
+
# form parameters
|
153
|
+
form_params = []
|
154
|
+
files_content = []
|
155
|
+
body = api_client.build_request_body(header_params, form_params, files_content)
|
156
|
+
{
|
157
|
+
'method': :GET,
|
158
|
+
'path': local_var_path,
|
159
|
+
'header_params': header_params,
|
160
|
+
'query_params': query_params,
|
161
|
+
'body': body,
|
162
|
+
'auth_names': ['JWT']
|
163
|
+
}
|
164
|
+
end
|
165
|
+
|
166
|
+
#
|
167
|
+
# Helper method to convert first letter to downcase
|
168
|
+
#
|
169
|
+
def downcase_first_letter(str)
|
170
|
+
str[0].downcase + str[1..-1]
|
171
|
+
end
|
172
|
+
|
173
|
+
# Get response type
|
174
|
+
def get_response_type
|
175
|
+
'SignatureCollectionResponse'
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
@@ -0,0 +1,186 @@
|
|
1
|
+
# ------------------------------------------------------------------------------------
|
2
|
+
# <copyright company="Aspose" file="remove_all_signatures_online_request.rb">
|
3
|
+
# Copyright (c) 2024 Aspose.Words for Cloud
|
4
|
+
# </copyright>
|
5
|
+
# <summary>
|
6
|
+
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
7
|
+
# of this software and associated documentation files (the "Software"), to deal
|
8
|
+
# in the Software without restriction, including without limitation the rights
|
9
|
+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10
|
+
# copies of the Software, and to permit persons to whom the Software is
|
11
|
+
# furnished to do so, subject to the following conditions:
|
12
|
+
#
|
13
|
+
# The above copyright notice and this permission notice shall be included in all
|
14
|
+
# copies or substantial portions of the Software.
|
15
|
+
#
|
16
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18
|
+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
19
|
+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20
|
+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21
|
+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
22
|
+
# SOFTWARE.
|
23
|
+
# </summary>
|
24
|
+
# ------------------------------------------------------------------------------------
|
25
|
+
|
26
|
+
module AsposeWordsCloud
|
27
|
+
|
28
|
+
#
|
29
|
+
# Request model for remove_all_signatures_online operation.
|
30
|
+
#
|
31
|
+
class RemoveAllSignaturesOnlineRequest
|
32
|
+
# The document.
|
33
|
+
attr_accessor :document
|
34
|
+
|
35
|
+
# Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
36
|
+
attr_accessor :load_encoding
|
37
|
+
|
38
|
+
# Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
|
39
|
+
attr_accessor :password
|
40
|
+
|
41
|
+
# Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
|
42
|
+
attr_accessor :encrypted_password
|
43
|
+
|
44
|
+
# The value indicates whether OpenType support is on.
|
45
|
+
attr_accessor :open_type_support
|
46
|
+
|
47
|
+
# Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
|
48
|
+
attr_accessor :dest_file_name
|
49
|
+
|
50
|
+
#
|
51
|
+
# Initializes a new instance.
|
52
|
+
# @param document The document.
|
53
|
+
# @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
54
|
+
# @param password Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
|
55
|
+
# @param encrypted_password Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
|
56
|
+
# @param open_type_support The value indicates whether OpenType support is on.
|
57
|
+
# @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
|
58
|
+
|
59
|
+
def initialize(document:, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, dest_file_name: nil)
|
60
|
+
self.document = document
|
61
|
+
self.load_encoding = load_encoding
|
62
|
+
self.password = password
|
63
|
+
self.encrypted_password = encrypted_password
|
64
|
+
self.open_type_support = open_type_support
|
65
|
+
self.dest_file_name = dest_file_name
|
66
|
+
end
|
67
|
+
|
68
|
+
# Creating batch part from request
|
69
|
+
def to_batch_part(api_client, requestId, parentRequestId = nil)
|
70
|
+
# verify the required parameter 'document' is set
|
71
|
+
raise ArgumentError, 'Missing the required parameter document when calling WordsApi.remove_all_signatures_online' if api_client.config.client_side_validation && self.document.nil?
|
72
|
+
|
73
|
+
# resource path
|
74
|
+
local_var_path = '/words/online/delete/signatures'[7..-1]
|
75
|
+
local_var_path = local_var_path.sub('//', '/')
|
76
|
+
|
77
|
+
# query parameters
|
78
|
+
query_params = {}
|
79
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
80
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
81
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
82
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
83
|
+
query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
|
84
|
+
|
85
|
+
if query_params
|
86
|
+
query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
|
87
|
+
end
|
88
|
+
|
89
|
+
header_params = {}
|
90
|
+
# header parameters
|
91
|
+
# HTTP header 'Content-Type'
|
92
|
+
header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
|
93
|
+
header_params['RequestId'] = requestId
|
94
|
+
|
95
|
+
if parentRequestId != nil
|
96
|
+
header_params['DependsOn'] = parentRequestId
|
97
|
+
end
|
98
|
+
|
99
|
+
# form parameters
|
100
|
+
form_params = []
|
101
|
+
files_content = []
|
102
|
+
if self.document.nil?
|
103
|
+
raise "Parameter Document is required."
|
104
|
+
end
|
105
|
+
unless self.document.nil?
|
106
|
+
form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
|
107
|
+
end
|
108
|
+
|
109
|
+
|
110
|
+
# http body (model)
|
111
|
+
body = api_client.build_request_body_batch(header_params, form_params, files_content)
|
112
|
+
part = ""
|
113
|
+
part.concat("PUT".force_encoding('UTF-8'))
|
114
|
+
part.concat(" ".force_encoding('UTF-8'))
|
115
|
+
part.concat(local_var_path.force_encoding('UTF-8'))
|
116
|
+
part.concat(" \r\n".force_encoding('UTF-8'))
|
117
|
+
|
118
|
+
header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
|
119
|
+
part.concat("\r\n".force_encoding('UTF-8'))
|
120
|
+
if body
|
121
|
+
if body.is_a?(Hash)
|
122
|
+
body.each do |key, value|
|
123
|
+
part.concat(value, "\r\n")
|
124
|
+
end
|
125
|
+
else
|
126
|
+
part.concat(body)
|
127
|
+
end
|
128
|
+
end
|
129
|
+
part
|
130
|
+
end
|
131
|
+
|
132
|
+
def create_http_request(api_client)
|
133
|
+
# verify the required parameter 'document' is set
|
134
|
+
raise ArgumentError, 'Missing the required parameter document when calling WordsApi.remove_all_signatures_online' if api_client.config.client_side_validation && self.document.nil?
|
135
|
+
|
136
|
+
# resource path
|
137
|
+
local_var_path = '/words/online/delete/signatures'[1..-1]
|
138
|
+
local_var_path = local_var_path.sub('//', '/')
|
139
|
+
|
140
|
+
# query parameters
|
141
|
+
query_params = {}
|
142
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
143
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
144
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
145
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
146
|
+
query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
|
147
|
+
|
148
|
+
# header parameters
|
149
|
+
header_params = {}
|
150
|
+
# HTTP header 'Content-Type'
|
151
|
+
header_params['Content-Type'] = api_client.select_header_content_type(['multipart/form-data'])
|
152
|
+
|
153
|
+
# form parameters
|
154
|
+
form_params = []
|
155
|
+
files_content = []
|
156
|
+
if self.document.nil?
|
157
|
+
raise "Parameter Document is required."
|
158
|
+
end
|
159
|
+
unless self.document.nil?
|
160
|
+
form_params.push({:'Name' => 'document', :'Data' => self.document, :'MimeType' =>'application/octet-stream'})
|
161
|
+
end
|
162
|
+
|
163
|
+
body = api_client.build_request_body(header_params, form_params, files_content)
|
164
|
+
{
|
165
|
+
'method': :PUT,
|
166
|
+
'path': local_var_path,
|
167
|
+
'header_params': header_params,
|
168
|
+
'query_params': query_params,
|
169
|
+
'body': body,
|
170
|
+
'auth_names': ['JWT']
|
171
|
+
}
|
172
|
+
end
|
173
|
+
|
174
|
+
#
|
175
|
+
# Helper method to convert first letter to downcase
|
176
|
+
#
|
177
|
+
def downcase_first_letter(str)
|
178
|
+
str[0].downcase + str[1..-1]
|
179
|
+
end
|
180
|
+
|
181
|
+
# Get response type
|
182
|
+
def get_response_type
|
183
|
+
'RemoveAllSignaturesOnlineResponse'
|
184
|
+
end
|
185
|
+
end
|
186
|
+
end
|
@@ -0,0 +1,185 @@
|
|
1
|
+
# ------------------------------------------------------------------------------------
|
2
|
+
# <copyright company="Aspose" file="remove_all_signatures_request.rb">
|
3
|
+
# Copyright (c) 2024 Aspose.Words for Cloud
|
4
|
+
# </copyright>
|
5
|
+
# <summary>
|
6
|
+
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
7
|
+
# of this software and associated documentation files (the "Software"), to deal
|
8
|
+
# in the Software without restriction, including without limitation the rights
|
9
|
+
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10
|
+
# copies of the Software, and to permit persons to whom the Software is
|
11
|
+
# furnished to do so, subject to the following conditions:
|
12
|
+
#
|
13
|
+
# The above copyright notice and this permission notice shall be included in all
|
14
|
+
# copies or substantial portions of the Software.
|
15
|
+
#
|
16
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17
|
+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18
|
+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
19
|
+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20
|
+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21
|
+
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
22
|
+
# SOFTWARE.
|
23
|
+
# </summary>
|
24
|
+
# ------------------------------------------------------------------------------------
|
25
|
+
|
26
|
+
module AsposeWordsCloud
|
27
|
+
|
28
|
+
#
|
29
|
+
# Request model for remove_all_signatures operation.
|
30
|
+
#
|
31
|
+
class RemoveAllSignaturesRequest
|
32
|
+
# Name of the document with signatures.
|
33
|
+
attr_accessor :name
|
34
|
+
|
35
|
+
# Original document folder.
|
36
|
+
attr_accessor :folder
|
37
|
+
|
38
|
+
# Original document storage.
|
39
|
+
attr_accessor :storage
|
40
|
+
|
41
|
+
# Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
42
|
+
attr_accessor :load_encoding
|
43
|
+
|
44
|
+
# Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
|
45
|
+
attr_accessor :password
|
46
|
+
|
47
|
+
# Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
|
48
|
+
attr_accessor :encrypted_password
|
49
|
+
|
50
|
+
# The value indicates whether OpenType support is on.
|
51
|
+
attr_accessor :open_type_support
|
52
|
+
|
53
|
+
# Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
|
54
|
+
attr_accessor :dest_file_name
|
55
|
+
|
56
|
+
#
|
57
|
+
# Initializes a new instance.
|
58
|
+
# @param name Name of the document with signatures.
|
59
|
+
# @param folder Original document folder.
|
60
|
+
# @param storage Original document storage.
|
61
|
+
# @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
|
62
|
+
# @param password Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
|
63
|
+
# @param encrypted_password Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
|
64
|
+
# @param open_type_support The value indicates whether OpenType support is on.
|
65
|
+
# @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
|
66
|
+
|
67
|
+
def initialize(name:, folder: nil, storage: nil, load_encoding: nil, password: nil, encrypted_password: nil, open_type_support: nil, dest_file_name: nil)
|
68
|
+
self.name = name
|
69
|
+
self.folder = folder
|
70
|
+
self.storage = storage
|
71
|
+
self.load_encoding = load_encoding
|
72
|
+
self.password = password
|
73
|
+
self.encrypted_password = encrypted_password
|
74
|
+
self.open_type_support = open_type_support
|
75
|
+
self.dest_file_name = dest_file_name
|
76
|
+
end
|
77
|
+
|
78
|
+
# Creating batch part from request
|
79
|
+
def to_batch_part(api_client, requestId, parentRequestId = nil)
|
80
|
+
# verify the required parameter 'name' is set
|
81
|
+
raise ArgumentError, 'Missing the required parameter name when calling WordsApi.remove_all_signatures' if api_client.config.client_side_validation && self.name.nil?
|
82
|
+
|
83
|
+
# resource path
|
84
|
+
local_var_path = '/words/{name}/signatures'[7..-1]
|
85
|
+
local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
|
86
|
+
local_var_path = local_var_path.sub('//', '/')
|
87
|
+
|
88
|
+
# query parameters
|
89
|
+
query_params = {}
|
90
|
+
query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
|
91
|
+
query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
|
92
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
93
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
94
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
95
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
96
|
+
query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
|
97
|
+
|
98
|
+
if query_params
|
99
|
+
query_params.each { |key, value| local_var_path = api_client.add_param_to_query(local_var_path, key, value) }
|
100
|
+
end
|
101
|
+
|
102
|
+
header_params = {}
|
103
|
+
header_params['RequestId'] = requestId
|
104
|
+
|
105
|
+
if parentRequestId != nil
|
106
|
+
header_params['DependsOn'] = parentRequestId
|
107
|
+
end
|
108
|
+
|
109
|
+
# form parameters
|
110
|
+
form_params = []
|
111
|
+
files_content = []
|
112
|
+
|
113
|
+
# http body (model)
|
114
|
+
body = api_client.build_request_body_batch(header_params, form_params, files_content)
|
115
|
+
part = ""
|
116
|
+
part.concat("DELETE".force_encoding('UTF-8'))
|
117
|
+
part.concat(" ".force_encoding('UTF-8'))
|
118
|
+
part.concat(local_var_path.force_encoding('UTF-8'))
|
119
|
+
part.concat(" \r\n".force_encoding('UTF-8'))
|
120
|
+
|
121
|
+
header_params.each_pair {|key, value| part.concat(key.dup.force_encoding('UTF-8') , ": ".force_encoding('UTF-8'), value.dup.force_encoding('UTF-8'), "\r\n".force_encoding('UTF-8')) }
|
122
|
+
part.concat("\r\n".force_encoding('UTF-8'))
|
123
|
+
if body
|
124
|
+
if body.is_a?(Hash)
|
125
|
+
body.each do |key, value|
|
126
|
+
part.concat(value, "\r\n")
|
127
|
+
end
|
128
|
+
else
|
129
|
+
part.concat(body)
|
130
|
+
end
|
131
|
+
end
|
132
|
+
part
|
133
|
+
end
|
134
|
+
|
135
|
+
def create_http_request(api_client)
|
136
|
+
# verify the required parameter 'name' is set
|
137
|
+
raise ArgumentError, 'Missing the required parameter name when calling WordsApi.remove_all_signatures' if api_client.config.client_side_validation && self.name.nil?
|
138
|
+
|
139
|
+
# resource path
|
140
|
+
local_var_path = '/words/{name}/signatures'[1..-1]
|
141
|
+
local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', self.name.nil? ? '' : self.name.to_s)
|
142
|
+
local_var_path = local_var_path.sub('//', '/')
|
143
|
+
|
144
|
+
# query parameters
|
145
|
+
query_params = {}
|
146
|
+
query_params[downcase_first_letter('Folder')] = self.folder unless self.folder.nil?
|
147
|
+
query_params[downcase_first_letter('Storage')] = self.storage unless self.storage.nil?
|
148
|
+
query_params[downcase_first_letter('LoadEncoding')] = self.load_encoding unless self.load_encoding.nil?
|
149
|
+
query_params[downcase_first_letter('Password')] = self.password unless self.password.nil?
|
150
|
+
query_params[downcase_first_letter('EncryptedPassword')] = self.encrypted_password unless self.encrypted_password.nil?
|
151
|
+
query_params[downcase_first_letter('OpenTypeSupport')] = self.open_type_support unless self.open_type_support.nil?
|
152
|
+
query_params[downcase_first_letter('DestFileName')] = self.dest_file_name unless self.dest_file_name.nil?
|
153
|
+
|
154
|
+
# header parameters
|
155
|
+
header_params = {}
|
156
|
+
# HTTP header 'Content-Type'
|
157
|
+
header_params['Content-Type'] = api_client.select_header_content_type(['application/xml', 'application/json'])
|
158
|
+
|
159
|
+
# form parameters
|
160
|
+
form_params = []
|
161
|
+
files_content = []
|
162
|
+
body = api_client.build_request_body(header_params, form_params, files_content)
|
163
|
+
{
|
164
|
+
'method': :DELETE,
|
165
|
+
'path': local_var_path,
|
166
|
+
'header_params': header_params,
|
167
|
+
'query_params': query_params,
|
168
|
+
'body': body,
|
169
|
+
'auth_names': ['JWT']
|
170
|
+
}
|
171
|
+
end
|
172
|
+
|
173
|
+
#
|
174
|
+
# Helper method to convert first letter to downcase
|
175
|
+
#
|
176
|
+
def downcase_first_letter(str)
|
177
|
+
str[0].downcase + str[1..-1]
|
178
|
+
end
|
179
|
+
|
180
|
+
# Get response type
|
181
|
+
def get_response_type
|
182
|
+
'SignatureCollectionResponse'
|
183
|
+
end
|
184
|
+
end
|
185
|
+
end
|