Class: Lockally::EncryptionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lockally/api/encryption_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EncryptionApi

Returns a new instance of EncryptionApi.



19
20
21
 
# File 'lib/lockally/api/encryption_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/lockally/api/encryption_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#batch_lookup_public_keys(emails, opts = {}) ⇒ BatchLookupPublicKeys200Response

Batch-lookup public keys by email

Parameters:

  • emails (String) —

    Comma-separated list of email addresses

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/lockally/api/encryption_api.rb', line 26

def batch_lookup_public_keys(emails, opts = {})
  data, _status_code, _headers = batch_lookup_public_keys_with_http_info(emails, opts)
  data
end

#batch_lookup_public_keys_with_http_info(emails, opts = {}) ⇒ Array<(BatchLookupPublicKeys200Response, Integer, Hash)>

Batch-lookup public keys by email

Parameters:

  • emails (String) —

    Comma-separated list of email addresses

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/lockally/api/encryption_api.rb', line 35

def batch_lookup_public_keys_with_http_info(emails, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EncryptionApi.batch_lookup_public_keys ...'
  end
  # verify the required parameter 'emails' is set
  if @api_client.config.client_side_validation && emails.nil?
    fail ArgumentError, "Missing the required parameter 'emails' when calling EncryptionApi.batch_lookup_public_keys"
  end
  # resource path
  local_var_path = '/v1/encryption/keys/lookup'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'emails'] = emails

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BatchLookupPublicKeys200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"EncryptionApi.batch_lookup_public_keys",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EncryptionApi#batch_lookup_public_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_encryption_key(create_encryption_key_request, opts = {}) ⇒ CreateEncryptionKey201Response

Upload an encryption key pair

Parameters:

Returns:



88
89
90
91
 
# File 'lib/lockally/api/encryption_api.rb', line 88

def create_encryption_key(create_encryption_key_request, opts = {})
  data, _status_code, _headers = create_encryption_key_with_http_info(create_encryption_key_request, opts)
  data
end

#create_encryption_key_with_http_info(create_encryption_key_request, opts = {}) ⇒ Array<(CreateEncryptionKey201Response, Integer, Hash)>

Upload an encryption key pair

Parameters:

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/lockally/api/encryption_api.rb', line 97

def create_encryption_key_with_http_info(create_encryption_key_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EncryptionApi.create_encryption_key ...'
  end
  # verify the required parameter 'create_encryption_key_request' is set
  if @api_client.config.client_side_validation && create_encryption_key_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_encryption_key_request' when calling EncryptionApi.create_encryption_key"
  end
  # resource path
  local_var_path = '/v1/encryption/keys'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_encryption_key_request)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateEncryptionKey201Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"EncryptionApi.create_encryption_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EncryptionApi#create_encryption_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_encryption_recovery(create_encryption_recovery_request, opts = {}) ⇒ nil

Store an encryption recovery blob

Parameters:

Returns:

  • (nil) 


154
155
156
157
 
# File 'lib/lockally/api/encryption_api.rb', line 154

def create_encryption_recovery(create_encryption_recovery_request, opts = {})
  create_encryption_recovery_with_http_info(create_encryption_recovery_request, opts)
  nil
end

#create_encryption_recovery_with_http_info(create_encryption_recovery_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Store an encryption recovery blob

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/lockally/api/encryption_api.rb', line 163

def create_encryption_recovery_with_http_info(create_encryption_recovery_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EncryptionApi.create_encryption_recovery ...'
  end
  # verify the required parameter 'create_encryption_recovery_request' is set
  if @api_client.config.client_side_validation && create_encryption_recovery_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_encryption_recovery_request' when calling EncryptionApi.create_encryption_recovery"
  end
  # resource path
  local_var_path = '/v1/encryption/recovery'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_encryption_recovery_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"EncryptionApi.create_encryption_recovery",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EncryptionApi#create_encryption_recovery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_encryption_key(email, opts = {}) ⇒ GetEncryptionKey200Response

Get encryption key for a mailbox

Parameters:

  • email (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



220
221
222
223
 
# File 'lib/lockally/api/encryption_api.rb', line 220

def get_encryption_key(email, opts = {})
  data, _status_code, _headers = get_encryption_key_with_http_info(email, opts)
  data
end

#get_encryption_key_with_http_info(email, opts = {}) ⇒ Array<(GetEncryptionKey200Response, Integer, Hash)>

Get encryption key for a mailbox

Parameters:

  • email (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(GetEncryptionKey200Response, Integer, Hash)>) —

    GetEncryptionKey200Response data, response status code and response headers



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
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
 
# File 'lib/lockally/api/encryption_api.rb', line 229

def get_encryption_key_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EncryptionApi.get_encryption_key ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling EncryptionApi.get_encryption_key"
  end
  # resource path
  local_var_path = '/v1/encryption/keys/{email}'.sub('{email}', CGI.escape(email.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetEncryptionKey200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"EncryptionApi.get_encryption_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EncryptionApi#get_encryption_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rotate_encryption_key(rotate_encryption_key_request, opts = {}) ⇒ nil

Rotate an encryption key

Parameters:

Returns:

  • (nil) 


281
282
283
284
 
# File 'lib/lockally/api/encryption_api.rb', line 281

def rotate_encryption_key(rotate_encryption_key_request, opts = {})
  rotate_encryption_key_with_http_info(rotate_encryption_key_request, opts)
  nil
end

#rotate_encryption_key_with_http_info(rotate_encryption_key_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Rotate an encryption key

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/lockally/api/encryption_api.rb', line 290

def rotate_encryption_key_with_http_info(rotate_encryption_key_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EncryptionApi.rotate_encryption_key ...'
  end
  # verify the required parameter 'rotate_encryption_key_request' is set
  if @api_client.config.client_side_validation && rotate_encryption_key_request.nil?
    fail ArgumentError, "Missing the required parameter 'rotate_encryption_key_request' when calling EncryptionApi.rotate_encryption_key"
  end
  # resource path
  local_var_path = '/v1/encryption/keys/rotate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(rotate_encryption_key_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"EncryptionApi.rotate_encryption_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EncryptionApi#rotate_encryption_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end