Class: Pingram::LogsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pingram/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.



19
20
21
 
# File 'lib/pingram/api/logs_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/pingram/api/logs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#logs_get_log_retention(opts = {}) ⇒ LogsRetentionResponse

Get log retention period in days for the account

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/pingram/api/logs_api.rb', line 25

def logs_get_log_retention(opts = {})
  data, _status_code, _headers = logs_get_log_retention_with_http_info(opts)
  data
end

#logs_get_log_retention_with_http_info(opts = {}) ⇒ Array<(LogsRetentionResponse, Integer, Hash)>

Get log retention period in days for the account

Parameters:

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

    the optional parameters

Returns:

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

    LogsRetentionResponse 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/pingram/api/logs_api.rb', line 33

def logs_get_log_retention_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.logs_get_log_retention ...'
  end
  # resource path
  local_var_path = '/logs/retention'

  # 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']) 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] || 'LogsRetentionResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#logs_get_logs(opts = {}) ⇒ GetLogsResponse

List logs for the authenticated account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Maximum number of logs to return (default

  • :cursor (String) —

    Pagination cursor for next page

Returns:



82
83
84
85
 
# File 'lib/pingram/api/logs_api.rb', line 82

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

#logs_get_logs_by_tracking_ids(tracking_ids, opts = {}) ⇒ LogsGetResponse

Get logs by tracking IDs (comma-separated, max 25 IDs)

Parameters:

  • tracking_ids (String) —

    Comma-separated tracking IDs (URL encoded)

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

    the optional parameters

Returns:



142
143
144
145
 
# File 'lib/pingram/api/logs_api.rb', line 142

def logs_get_logs_by_tracking_ids(tracking_ids, opts = {})
  data, _status_code, _headers = logs_get_logs_by_tracking_ids_with_http_info(tracking_ids, opts)
  data
end

#logs_get_logs_by_tracking_ids_with_http_info(tracking_ids, opts = {}) ⇒ Array<(LogsGetResponse, Integer, Hash)>

Get logs by tracking IDs (comma-separated, max 25 IDs)

Parameters:

  • tracking_ids (String) —

    Comma-separated tracking IDs (URL encoded)

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

    the optional parameters

Returns:

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

    LogsGetResponse data, response status code and response headers



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
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/pingram/api/logs_api.rb', line 151

def logs_get_logs_by_tracking_ids_with_http_info(tracking_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.logs_get_logs_by_tracking_ids ...'
  end
  # verify the required parameter 'tracking_ids' is set
  if @api_client.config.client_side_validation && tracking_ids.nil?
    fail ArgumentError, "Missing the required parameter 'tracking_ids' when calling LogsApi.logs_get_logs_by_tracking_ids"
  end
  # resource path
  local_var_path = '/logs/{trackingIds}'.sub('{' + 'trackingIds' + '}', CGI.escape(tracking_ids.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']) 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] || 'LogsGetResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#logs_get_logs_query_result(query_id, opts = {}) ⇒ LogsQueryResultResponse

Get results from a query ID

Parameters:

  • query_id (String) —

    Query ID

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

    the optional parameters

Returns:



203
204
205
206
 
# File 'lib/pingram/api/logs_api.rb', line 203

def logs_get_logs_query_result(query_id, opts = {})
  data, _status_code, _headers = logs_get_logs_query_result_with_http_info(query_id, opts)
  data
end

#logs_get_logs_query_result_with_http_info(query_id, opts = {}) ⇒ Array<(LogsQueryResultResponse, Integer, Hash)>

Get results from a query ID

Parameters:

  • query_id (String) —

    Query ID

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

    the optional parameters

Returns:

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

    LogsQueryResultResponse data, response status code and response headers



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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/pingram/api/logs_api.rb', line 212

def logs_get_logs_query_result_with_http_info(query_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.logs_get_logs_query_result ...'
  end
  # verify the required parameter 'query_id' is set
  if @api_client.config.client_side_validation && query_id.nil?
    fail ArgumentError, "Missing the required parameter 'query_id' when calling LogsApi.logs_get_logs_query_result"
  end
  # resource path
  local_var_path = '/logs/query/{queryId}'.sub('{' + 'queryId' + '}', CGI.escape(query_id.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']) 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] || 'LogsQueryResultResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

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

List logs for the authenticated account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Maximum number of logs to return (default

  • :cursor (String) —

    Pagination cursor for next page

Returns:

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

    GetLogsResponse data, response status code and response headers



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
131
132
133
134
135
136
 
# File 'lib/pingram/api/logs_api.rb', line 92

def logs_get_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.logs_get_logs ...'
  end
  # resource path
  local_var_path = '/logs'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/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] || 'GetLogsResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#logs_start_logs_query(log_query_post_body, opts = {}) ⇒ LogsQueryResponse

Start a log query and return query ID for asynchronous log searching

Parameters:

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

    the optional parameters

Returns:



264
265
266
267
 
# File 'lib/pingram/api/logs_api.rb', line 264

def logs_start_logs_query(log_query_post_body, opts = {})
  data, _status_code, _headers = logs_start_logs_query_with_http_info(log_query_post_body, opts)
  data
end

#logs_start_logs_query_with_http_info(log_query_post_body, opts = {}) ⇒ Array<(LogsQueryResponse, Integer, Hash)>

Start a log query and return query ID for asynchronous log searching

Parameters:

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

    the optional parameters

Returns:

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

    LogsQueryResponse data, response status code and response headers



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
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
 
# File 'lib/pingram/api/logs_api.rb', line 273

def logs_start_logs_query_with_http_info(log_query_post_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.logs_start_logs_query ...'
  end
  # verify the required parameter 'log_query_post_body' is set
  if @api_client.config.client_side_validation && log_query_post_body.nil?
    fail ArgumentError, "Missing the required parameter 'log_query_post_body' when calling LogsApi.logs_start_logs_query"
  end
  # resource path
  local_var_path = '/logs/query'

  # 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']) 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(log_query_post_body)

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

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#logs_tail_logs(opts = {}) ⇒ LogsTailResponse

Get last 100 logs from the stream

Parameters:

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

    the optional parameters

Returns:



329
330
331
332
 
# File 'lib/pingram/api/logs_api.rb', line 329

def logs_tail_logs(opts = {})
  data, _status_code, _headers = logs_tail_logs_with_http_info(opts)
  data
end

#logs_tail_logs_with_http_info(opts = {}) ⇒ Array<(LogsTailResponse, Integer, Hash)>

Get last 100 logs from the stream

Parameters:

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

    the optional parameters

Returns:

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

    LogsTailResponse data, response status code and response headers



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/pingram/api/logs_api.rb', line 337

def logs_tail_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsApi.logs_tail_logs ...'
  end
  # resource path
  local_var_path = '/logs/tail'

  # 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']) 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] || 'LogsTailResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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