Class: Lockally::DashboardApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DashboardApi

Returns a new instance of DashboardApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_audit_summary(opts = {}) ⇒ GetAuditSummary200Response

Audit summary for the dashboard

Parameters:

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

    the optional parameters

Returns:



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

def get_audit_summary(opts = {})
  data, _status_code, _headers = get_audit_summary_with_http_info(opts)
  data
end

#get_audit_summary_with_http_info(opts = {}) ⇒ Array<(GetAuditSummary200Response, Integer, Hash)>

Audit summary for the dashboard

Parameters:

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

    the optional parameters

Returns:

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

    GetAuditSummary200Response data, response status code and response headers



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/dashboard_api.rb', line 33

def get_audit_summary_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardApi.get_audit_summary ...'
  end
  # resource path
  local_var_path = '/v1/audit-summary'

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

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

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

#get_domains_status(opts = {}) ⇒ GetDomainsStatus200Response

Domain health status for the dashboard

Parameters:

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

    the optional parameters

Returns:



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

def get_domains_status(opts = {})
  data, _status_code, _headers = get_domains_status_with_http_info(opts)
  data
end

#get_domains_status_with_http_info(opts = {}) ⇒ Array<(GetDomainsStatus200Response, Integer, Hash)>

Domain health status for the dashboard

Parameters:

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

    the optional parameters

Returns:

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

    GetDomainsStatus200Response 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/dashboard_api.rb', line 88

def get_domains_status_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardApi.get_domains_status ...'
  end
  # resource path
  local_var_path = '/v1/domains/status'

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

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

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

#get_integrations_summary(opts = {}) ⇒ GetIntegrationsSummary200Response

Integrations summary for the dashboard

Parameters:

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

    the optional parameters

Returns:



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

def get_integrations_summary(opts = {})
  data, _status_code, _headers = get_integrations_summary_with_http_info(opts)
  data
end

#get_integrations_summary_with_http_info(opts = {}) ⇒ Array<(GetIntegrationsSummary200Response, Integer, Hash)>

Integrations summary for the dashboard

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/dashboard_api.rb', line 143

def get_integrations_summary_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardApi.get_integrations_summary ...'
  end
  # resource path
  local_var_path = '/v1/integrations-summary'

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

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

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

#get_security(opts = {}) ⇒ GetSecurity200Response

Security overview for the dashboard

Parameters:

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

    the optional parameters

Returns:



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

def get_security(opts = {})
  data, _status_code, _headers = get_security_with_http_info(opts)
  data
end

#get_security_with_http_info(opts = {}) ⇒ Array<(GetSecurity200Response, Integer, Hash)>

Security overview for the dashboard

Parameters:

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

    the optional parameters

Returns:

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

    GetSecurity200Response 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/dashboard_api.rb', line 198

def get_security_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardApi.get_security ...'
  end
  # resource path
  local_var_path = '/v1/security'

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

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

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

#get_storage(opts = {}) ⇒ GetStorage200Response

Storage usage for the dashboard

Parameters:

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

    the optional parameters

Returns:



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

def get_storage(opts = {})
  data, _status_code, _headers = get_storage_with_http_info(opts)
  data
end

#get_storage_with_http_info(opts = {}) ⇒ Array<(GetStorage200Response, Integer, Hash)>

Storage usage for the dashboard

Parameters:

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

    the optional parameters

Returns:

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

    GetStorage200Response 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/dashboard_api.rb', line 253

def get_storage_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardApi.get_storage ...'
  end
  # resource path
  local_var_path = '/v1/storage'

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

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

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

#get_tenant_health(opts = {}) ⇒ Object

Full tenant health report

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


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

def get_tenant_health(opts = {})
  data, _status_code, _headers = get_tenant_health_with_http_info(opts)
  data
end

#get_tenant_health_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Full tenant health report

Parameters:

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

    the optional parameters

Returns:

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

    Object 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/dashboard_api.rb', line 308

def get_tenant_health_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardApi.get_tenant_health ...'
  end
  # resource path
  local_var_path = '/v1/health'

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

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

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

#get_user_insights(opts = {}) ⇒ GetUserInsights200Response

User insights for the dashboard

Parameters:

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

    the optional parameters

Returns:



355
356
357
358
 
# File 'lib/lockally/api/dashboard_api.rb', line 355

def get_user_insights(opts = {})
  data, _status_code, _headers = get_user_insights_with_http_info(opts)
  data
end

#get_user_insights_with_http_info(opts = {}) ⇒ Array<(GetUserInsights200Response, Integer, Hash)>

User insights for the dashboard

Parameters:

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

    the optional parameters

Returns:

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

    GetUserInsights200Response data, response status code and response headers



363
364
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
 
# File 'lib/lockally/api/dashboard_api.rb', line 363

def get_user_insights_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DashboardApi.get_user_insights ...'
  end
  # resource path
  local_var_path = '/v1/user-insights'

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

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

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