Class: Notifo::LogsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/api/logs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LogsApi

Returns a new instance of LogsApi.



16
17
18
 
# File 'lib/notifo/api/logs_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/notifo/api/logs_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#logs_get_logs(app_id, opts = {}) ⇒ ListResponseDtoOfLogEntryDto

Query log entries.

Parameters:

  • app_id —

    The app where the log entries belongs to.

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



26
27
28
29
 
# File 'lib/notifo/api/logs_api.rb', line 26

def logs_get_logs(app_id, opts = {})
  data, _status_code, _headers = logs_get_logs_with_http_info(app_id, opts)
  data
end

#logs_get_logs_with_http_info(app_id, opts = {}) ⇒ Array<(ListResponseDtoOfLogEntryDto, Integer, Hash)>

Query log entries.

Parameters:

  • app_id —

    The app where the log entries belongs to.

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



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
 
# File 'lib/notifo/api/logs_api.rb', line 38

def logs_get_logs_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.logs_get_logs ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling LogsApi.logs_get_logs"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/logs'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

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

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

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

  return_type = opts[:return_type] || 'ListResponseDtoOfLogEntryDto' 

  auth_names = opts[:auth_names] || []
  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,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LogsApi#logs_get_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end