Class: Lockally::DirectoryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DirectoryApi

Returns a new instance of DirectoryApi.



19
20
21
 
# File 'lib/lockally/api/directory_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/directory_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_directory_activity(opts = {}) ⇒ GetDirectoryActivity200Response

Get recent directory activity

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/lockally/api/directory_api.rb', line 25

def get_directory_activity(opts = {})
  data, _status_code, _headers = get_directory_activity_with_http_info(opts)
  data
end

#get_directory_activity_with_http_info(opts = {}) ⇒ Array<(GetDirectoryActivity200Response, Integer, Hash)>

Get recent directory activity

Parameters:

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

    the optional parameters

Returns:



33
34
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
 
# File 'lib/lockally/api/directory_api.rb', line 33

def get_directory_activity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.get_directory_activity ...'
  end
  # resource path
  local_var_path = '/v1/directory-activity'

  # 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] || 'GetDirectoryActivity200Response'

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.get_directory_activity",
    :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: DirectoryApi#get_directory_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_directory_permissions(opts = {}) ⇒ DirectoryPermissions

Get directory permission settings

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/lockally/api/directory_api.rb', line 80

def get_directory_permissions(opts = {})
  data, _status_code, _headers = get_directory_permissions_with_http_info(opts)
  data
end

#get_directory_permissions_with_http_info(opts = {}) ⇒ Array<(DirectoryPermissions, Integer, Hash)>

Get directory permission settings

Parameters:

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

    the optional parameters

Returns:

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

    DirectoryPermissions data, response status code and response headers



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
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/lockally/api/directory_api.rb', line 88

def get_directory_permissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.get_directory_permissions ...'
  end
  # resource path
  local_var_path = '/v1/directory-permissions'

  # 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] || 'DirectoryPermissions'

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.get_directory_permissions",
    :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: DirectoryApi#get_directory_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_directory_stats(opts = {}) ⇒ GetDirectoryStats200Response

Get directory statistics

Parameters:

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/lockally/api/directory_api.rb', line 135

def get_directory_stats(opts = {})
  data, _status_code, _headers = get_directory_stats_with_http_info(opts)
  data
end

#get_directory_stats_with_http_info(opts = {}) ⇒ Array<(GetDirectoryStats200Response, Integer, Hash)>

Get directory statistics

Parameters:

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

    the optional parameters

Returns:



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
182
183
184
185
 
# File 'lib/lockally/api/directory_api.rb', line 143

def get_directory_stats_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.get_directory_stats ...'
  end
  # resource path
  local_var_path = '/v1/directory-stats'

  # 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] || 'GetDirectoryStats200Response'

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.get_directory_stats",
    :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: DirectoryApi#get_directory_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_gal_settings(opts = {}) ⇒ GALSettings

Get Global Address List settings

Parameters:

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

    the optional parameters

Returns:



190
191
192
193
 
# File 'lib/lockally/api/directory_api.rb', line 190

def get_gal_settings(opts = {})
  data, _status_code, _headers = get_gal_settings_with_http_info(opts)
  data
end

#get_gal_settings_with_http_info(opts = {}) ⇒ Array<(GALSettings, Integer, Hash)>

Get Global Address List settings

Parameters:

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

    the optional parameters

Returns:

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

    GALSettings data, response status code and response headers



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
234
235
236
237
238
239
240
 
# File 'lib/lockally/api/directory_api.rb', line 198

def get_gal_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.get_gal_settings ...'
  end
  # resource path
  local_var_path = '/v1/gal-settings'

  # 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] || 'GALSettings'

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.get_gal_settings",
    :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: DirectoryApi#get_gal_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rebuild_gal_index(opts = {}) ⇒ GALSettings

Rebuild the GAL search index

Parameters:

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

    the optional parameters

Returns:



245
246
247
248
 
# File 'lib/lockally/api/directory_api.rb', line 245

def rebuild_gal_index(opts = {})
  data, _status_code, _headers = rebuild_gal_index_with_http_info(opts)
  data
end

#rebuild_gal_index_with_http_info(opts = {}) ⇒ Array<(GALSettings, Integer, Hash)>

Rebuild the GAL search index

Parameters:

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

    the optional parameters

Returns:

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

    GALSettings data, response status code and response headers



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
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/lockally/api/directory_api.rb', line 253

def rebuild_gal_index_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.rebuild_gal_index ...'
  end
  # resource path
  local_var_path = '/v1/gal-settings/rebuild-index'

  # 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] || 'GALSettings'

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.rebuild_gal_index",
    :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: DirectoryApi#rebuild_gal_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync_gal(opts = {}) ⇒ GALSettings

Sync GAL with external directory sources

Parameters:

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

    the optional parameters

Returns:



300
301
302
303
 
# File 'lib/lockally/api/directory_api.rb', line 300

def sync_gal(opts = {})
  data, _status_code, _headers = sync_gal_with_http_info(opts)
  data
end

#sync_gal_with_http_info(opts = {}) ⇒ Array<(GALSettings, Integer, Hash)>

Sync GAL with external directory sources

Parameters:

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

    the optional parameters

Returns:

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

    GALSettings data, response status code and response headers



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
342
343
344
345
346
347
348
349
350
 
# File 'lib/lockally/api/directory_api.rb', line 308

def sync_gal_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.sync_gal ...'
  end
  # resource path
  local_var_path = '/v1/gal-settings/sync'

  # 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] || 'GALSettings'

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.sync_gal",
    :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: DirectoryApi#sync_gal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_directory_permissions(update_directory_permissions_request, opts = {}) ⇒ DirectoryPermissions

Update directory permission settings

Parameters:

Returns:



356
357
358
359
 
# File 'lib/lockally/api/directory_api.rb', line 356

def update_directory_permissions(update_directory_permissions_request, opts = {})
  data, _status_code, _headers = update_directory_permissions_with_http_info(update_directory_permissions_request, opts)
  data
end

#update_directory_permissions_with_http_info(update_directory_permissions_request, opts = {}) ⇒ Array<(DirectoryPermissions, Integer, Hash)>

Update directory permission settings

Parameters:

Returns:

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

    DirectoryPermissions data, response status code and response headers



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/lockally/api/directory_api.rb', line 365

def update_directory_permissions_with_http_info(update_directory_permissions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.update_directory_permissions ...'
  end
  # verify the required parameter 'update_directory_permissions_request' is set
  if @api_client.config.client_side_validation && update_directory_permissions_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_directory_permissions_request' when calling DirectoryApi.update_directory_permissions"
  end
  # resource path
  local_var_path = '/v1/directory-permissions'

  # 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(update_directory_permissions_request)

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

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.update_directory_permissions",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectoryApi#update_directory_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_gal_settings(update_gal_settings_request, opts = {}) ⇒ GALSettings

Update GAL settings

Parameters:

Returns:



422
423
424
425
 
# File 'lib/lockally/api/directory_api.rb', line 422

def update_gal_settings(update_gal_settings_request, opts = {})
  data, _status_code, _headers = update_gal_settings_with_http_info(update_gal_settings_request, opts)
  data
end

#update_gal_settings_with_http_info(update_gal_settings_request, opts = {}) ⇒ Array<(GALSettings, Integer, Hash)>

Update GAL settings

Parameters:

Returns:

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

    GALSettings data, response status code and response headers



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/lockally/api/directory_api.rb', line 431

def update_gal_settings_with_http_info(update_gal_settings_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DirectoryApi.update_gal_settings ...'
  end
  # verify the required parameter 'update_gal_settings_request' is set
  if @api_client.config.client_side_validation && update_gal_settings_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_gal_settings_request' when calling DirectoryApi.update_gal_settings"
  end
  # resource path
  local_var_path = '/v1/gal-settings'

  # 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(update_gal_settings_request)

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

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

  new_options = opts.merge(
    :operation => :"DirectoryApi.update_gal_settings",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DirectoryApi#update_gal_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end