Class: GroupDocsMergerCloud::SecurityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_merger_cloud/api/security_api.rb

Overview

GroupDocs.Merger Cloud API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ SecurityApi

Initializes new instance of SecurityApi

Parameters:



43
44
45
46
47
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 43

def initialize(config)
  @config = config
  @api_client = ApiClient.new(config)
  @access_token = nil
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



34
35
36
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 34

def config
  @config
end

Class Method Details

.from_config(config) ⇒ SecurityApi

Initializes new instance of SecurityApi

Parameters:

Returns:



63
64
65
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 63

def self.from_config(config)
  return new(config)
end

.from_keys(app_sid, app_key) ⇒ SecurityApi

Initializes new instance of SecurityApi

Parameters:

  • Application (app_sid) —

    identifier (App SID)

  • Application (app_key) —

    private key (App Key)

Returns:



54
55
56
57
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 54

def self.from_keys(app_sid, app_key)
  config = Configuration.new(app_sid, app_key)
  return new(config)
end

Instance Method Details

#add_password(request) ⇒ DocumentResult

Add document password protection

Parameters:

  • request —

    add_password_request

Returns:



71
72
73
74
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 71

def add_password(request)
  data, _status_code, _headers = add_password_with_http_info(request)
  data
end

#add_password_with_http_info(request) ⇒ Array<(DocumentResult, Fixnum, Hash)>

Add document password protection

DocumentResult data, response status code and response headers

Parameters:

  • request —

    add_password_request

Returns:

Raises:

  • (ArgumentError) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 81

def add_password_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? AddPasswordRequest

  @api_client.config.logger.debug 'Calling API: SecurityApi.add_password ...' if @api_client.config.debugging
  # verify the required parameter 'options' is set
  raise ArgumentError, 'Missing the required parameter options when calling SecurityApi.add_password' if @api_client.config.client_side_validation && request.options.nil?
  # resource path
  local_var_path = '/merger/password'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.options)
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    access_token: get_access_token,
                                                    return_type: 'DocumentResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SecurityApi#add_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#check_password(request) ⇒ PasswordResult

Checks whether document is password protected

Parameters:

  • request —

    check_password_request

Returns:



123
124
125
126
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 123

def check_password(request)
  data, _status_code, _headers = check_password_with_http_info(request)
  data
end

#check_password_with_http_info(request) ⇒ Array<(PasswordResult, Fixnum, Hash)>

Checks whether document is password protected

PasswordResult data, response status code and response headers

Parameters:

  • request —

    check_password_request

Returns:

Raises:

  • (ArgumentError) 


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 133

def check_password_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? CheckPasswordRequest

  @api_client.config.logger.debug 'Calling API: SecurityApi.check_password ...' if @api_client.config.debugging
  # verify the required parameter 'file_path' is set
  raise ArgumentError, 'Missing the required parameter file_path when calling SecurityApi.check_password' if @api_client.config.client_side_validation && request.file_path.nil?
  # resource path
  local_var_path = '/merger/password'

  # query parameters
  query_params = {}
  query_params[downcase_first_letter('filePath')] = request.file_path

  if local_var_path.include? ('{' + downcase_first_letter('storageName') + '}')
    local_var_path = local_var_path.sub('{' + downcase_first_letter('storageName') + '}', request.storage_name.to_s)
  else
    query_params[downcase_first_letter('storageName')] = request.storage_name unless request.storage_name.nil?
  end
  if local_var_path.include? ('{' + downcase_first_letter('versionId') + '}')
    local_var_path = local_var_path.sub('{' + downcase_first_letter('versionId') + '}', request.version_id.to_s)
  else
    query_params[downcase_first_letter('versionId')] = request.version_id unless request.version_id.nil?
  end

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    access_token: get_access_token,
                                                    return_type: 'PasswordResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SecurityApi#check_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#remove_password(request) ⇒ DocumentResult

Remove document password protection

Parameters:

  • request —

    remove_password_request

Returns:



187
188
189
190
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 187

def remove_password(request)
  data, _status_code, _headers = remove_password_with_http_info(request)
  data
end

#remove_password_with_http_info(request) ⇒ Array<(DocumentResult, Fixnum, Hash)>

Remove document password protection

DocumentResult data, response status code and response headers

Parameters:

  • request —

    remove_password_request

Returns:

Raises:

  • (ArgumentError) 


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 197

def remove_password_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? RemovePasswordRequest

  @api_client.config.logger.debug 'Calling API: SecurityApi.remove_password ...' if @api_client.config.debugging
  # verify the required parameter 'options' is set
  raise ArgumentError, 'Missing the required parameter options when calling SecurityApi.remove_password' if @api_client.config.client_side_validation && request.options.nil?
  # resource path
  local_var_path = '/merger/password'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.options)
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    access_token: get_access_token,
                                                    return_type: 'DocumentResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SecurityApi#remove_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#update_password(request) ⇒ DocumentResult

Update document password

Parameters:

  • request —

    update_password_request

Returns:



239
240
241
242
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 239

def update_password(request)
  data, _status_code, _headers = update_password_with_http_info(request)
  data
end

#update_password_with_http_info(request) ⇒ Array<(DocumentResult, Fixnum, Hash)>

Update document password

DocumentResult data, response status code and response headers

Parameters:

  • request —

    update_password_request

Returns:

Raises:

  • (ArgumentError) 


249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/groupdocs_merger_cloud/api/security_api.rb', line 249

def update_password_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? UpdatePasswordRequest

  @api_client.config.logger.debug 'Calling API: SecurityApi.update_password ...' if @api_client.config.debugging
  # verify the required parameter 'options' is set
  raise ArgumentError, 'Missing the required parameter options when calling SecurityApi.update_password' if @api_client.config.client_side_validation && request.options.nil?
  # resource path
  local_var_path = '/merger/password'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.options)
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    access_token: get_access_token,
                                                    return_type: 'DocumentResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    SecurityApi#update_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end