Class: ElasticEmail::EventsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/api/events_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.



19
20
21
 
# File 'lib/ElasticEmail/api/events_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/ElasticEmail/api/events_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#events_by_transactionid_get(transactionid, opts = {}) ⇒ Array<RecipientEvent>

Load Email Events Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports

Parameters:

  • transactionid (String) —

    ID number of transaction

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

    the optional parameters

Options Hash (opts):

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :order_by (EventsOrderBy) — default: default to 'DateDescending'
  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



32
33
34
35
 
# File 'lib/ElasticEmail/api/events_api.rb', line 32

def events_by_transactionid_get(transactionid, opts = {})
  data, _status_code, _headers = events_by_transactionid_get_with_http_info(transactionid, opts)
  data
end

#events_by_transactionid_get_with_http_info(transactionid, opts = {}) ⇒ Array<(Array<RecipientEvent>, Integer, Hash)>

Load Email Events Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports

Parameters:

  • transactionid (String) —

    ID number of transaction

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

    the optional parameters

Options Hash (opts):

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :order_by (EventsOrderBy) — default: default to 'DateDescending'
  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

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

    Array<RecipientEvent> data, response status code and response headers



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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ElasticEmail/api/events_api.rb', line 47

def events_by_transactionid_get_with_http_info(transactionid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_by_transactionid_get ...'
  end
  # verify the required parameter 'transactionid' is set
  if @api_client.config.client_side_validation && transactionid.nil?
    fail ArgumentError, "Missing the required parameter 'transactionid' when calling EventsApi.events_by_transactionid_get"
  end
  # resource path
  local_var_path = '/events/{transactionid}'.sub('{' + 'transactionid' + '}', CGI.escape(transactionid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RecipientEvent>'

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

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

#events_channels_by_name_export_post(name, opts = {}) ⇒ ExportLink

Export Channel Events Export delivery events log information to the specified file format. Required Access Level: Export

Parameters:

  • name (String) —

    Name of selected channel.

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :file_format (ExportFileFormats) —

    Format of the exported file (default to 'Csv')

  • :compression_format (CompressionFormat) —

    FileResponse compression format. None or Zip. (default to 'None')

  • :file_name (String) —

    Name of your file including extension.

Returns:



111
112
113
114
 
# File 'lib/ElasticEmail/api/events_api.rb', line 111

def events_channels_by_name_export_post(name, opts = {})
  data, _status_code, _headers = events_channels_by_name_export_post_with_http_info(name, opts)
  data
end

#events_channels_by_name_export_post_with_http_info(name, opts = {}) ⇒ Array<(ExportLink, Integer, Hash)>

Export Channel Events Export delivery events log information to the specified file format. Required Access Level: Export

Parameters:

  • name (String) —

    Name of selected channel.

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :file_format (ExportFileFormats) —

    Format of the exported file (default to 'Csv')

  • :compression_format (CompressionFormat) —

    FileResponse compression format. None or Zip. (default to 'None')

  • :file_name (String) —

    Name of your file including extension.

Returns:

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

    ExportLink data, response status code and response headers



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
 
# File 'lib/ElasticEmail/api/events_api.rb', line 127

def events_channels_by_name_export_post_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_channels_by_name_export_post ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling EventsApi.events_channels_by_name_export_post"
  end
  # resource path
  local_var_path = '/events/channels/{name}/export'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'eventTypes'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'fileFormat'] = opts[:'file_format'] if !opts[:'file_format'].nil?
  query_params[:'compressionFormat'] = opts[:'compression_format'] if !opts[:'compression_format'].nil?
  query_params[:'fileName'] = opts[:'file_name'] if !opts[:'file_name'].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[:debug_body]

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

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

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

#events_channels_by_name_get(name, opts = {}) ⇒ Array<RecipientEvent>

Load Channel Events Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports

Parameters:

  • name (String) —

    Name of selected channel.

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :order_by (EventsOrderBy) — default: default to 'DateDescending'
  • :limit (Integer) —

    How many items to load. Maximum for this request is 1000 items

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



192
193
194
195
 
# File 'lib/ElasticEmail/api/events_api.rb', line 192

def events_channels_by_name_get(name, opts = {})
  data, _status_code, _headers = events_channels_by_name_get_with_http_info(name, opts)
  data
end

#events_channels_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(Array<RecipientEvent>, Integer, Hash)>

Load Channel Events Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports

Parameters:

  • name (String) —

    Name of selected channel.

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :order_by (EventsOrderBy) — default: default to 'DateDescending'
  • :limit (Integer) —

    How many items to load. Maximum for this request is 1000 items

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

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

    Array<RecipientEvent> data, response status code and response headers



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

def events_channels_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_channels_by_name_get ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling EventsApi.events_channels_by_name_get"
  end
  # resource path
  local_var_path = '/events/channels/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'eventTypes'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RecipientEvent>'

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

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

#events_channels_export_by_id_status_get(id, opts = {}) ⇒ ExportStatus

Check Channel Export Status Check the current status of the channel export. Required Access Level: Export

Parameters:

  • id (String) —

    ID of the exported file

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

    the optional parameters

Returns:



267
268
269
270
 
# File 'lib/ElasticEmail/api/events_api.rb', line 267

def events_channels_export_by_id_status_get(id, opts = {})
  data, _status_code, _headers = events_channels_export_by_id_status_get_with_http_info(id, opts)
  data
end

#events_channels_export_by_id_status_get_with_http_info(id, opts = {}) ⇒ Array<(ExportStatus, Integer, Hash)>

Check Channel Export Status Check the current status of the channel export. Required Access Level: Export

Parameters:

  • id (String) —

    ID of the exported file

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

    the optional parameters

Returns:

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

    ExportStatus data, response status code and response headers



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
 
# File 'lib/ElasticEmail/api/events_api.rb', line 277

def events_channels_export_by_id_status_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_channels_export_by_id_status_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.events_channels_export_by_id_status_get"
  end
  # resource path
  local_var_path = '/events/channels/export/{id}/status'.sub('{' + 'id' + '}', CGI.escape(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'])

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

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

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

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

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

#events_export_by_id_status_get(id, opts = {}) ⇒ ExportStatus

Check Export Status Check the current status of the export. Required Access Level: Export

Parameters:

  • id (String) —

    ID of the exported file

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

    the optional parameters

Returns:



330
331
332
333
 
# File 'lib/ElasticEmail/api/events_api.rb', line 330

def events_export_by_id_status_get(id, opts = {})
  data, _status_code, _headers = events_export_by_id_status_get_with_http_info(id, opts)
  data
end

#events_export_by_id_status_get_with_http_info(id, opts = {}) ⇒ Array<(ExportStatus, Integer, Hash)>

Check Export Status Check the current status of the export. Required Access Level: Export

Parameters:

  • id (String) —

    ID of the exported file

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

    the optional parameters

Returns:

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

    ExportStatus data, response status code and response headers



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
380
381
382
383
384
385
386
 
# File 'lib/ElasticEmail/api/events_api.rb', line 340

def events_export_by_id_status_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_export_by_id_status_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.events_export_by_id_status_get"
  end
  # resource path
  local_var_path = '/events/export/{id}/status'.sub('{' + 'id' + '}', CGI.escape(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'])

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

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

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

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

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

#events_export_post(opts = {}) ⇒ ExportLink

Export Events Export delivery events log information to the specified file format. Required Access Level: Export

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :file_format (ExportFileFormats) —

    Format of the exported file (default to 'Csv')

  • :compression_format (CompressionFormat) —

    FileResponse compression format. None or Zip. (default to 'None')

  • :file_name (String) —

    Name of your file including extension.

Returns:



398
399
400
401
 
# File 'lib/ElasticEmail/api/events_api.rb', line 398

def events_export_post(opts = {})
  data, _status_code, _headers = events_export_post_with_http_info(opts)
  data
end

#events_export_post_with_http_info(opts = {}) ⇒ Array<(ExportLink, Integer, Hash)>

Export Events Export delivery events log information to the specified file format. Required Access Level: Export

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :file_format (ExportFileFormats) —

    Format of the exported file (default to 'Csv')

  • :compression_format (CompressionFormat) —

    FileResponse compression format. None or Zip. (default to 'None')

  • :file_name (String) —

    Name of your file including extension.

Returns:

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

    ExportLink data, response status code and response headers



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
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
 
# File 'lib/ElasticEmail/api/events_api.rb', line 413

def events_export_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_export_post ...'
  end
  # resource path
  local_var_path = '/events/export'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'eventTypes'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'fileFormat'] = opts[:'file_format'] if !opts[:'file_format'].nil?
  query_params[:'compressionFormat'] = opts[:'compression_format'] if !opts[:'compression_format'].nil?
  query_params[:'fileName'] = opts[:'file_name'] if !opts[:'file_name'].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[:debug_body]

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

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

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

#events_get(opts = {}) ⇒ Array<RecipientEvent>

Load Events Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :order_by (EventsOrderBy) — default: default to 'DateDescending'
  • :limit (Integer) —

    How many items to load. Maximum for this request is 1000 items

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



473
474
475
476
 
# File 'lib/ElasticEmail/api/events_api.rb', line 473

def events_get(opts = {})
  data, _status_code, _headers = events_get_with_http_info(opts)
  data
end

#events_get_with_http_info(opts = {}) ⇒ Array<(Array<RecipientEvent>, Integer, Hash)>

Load Events Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :event_types (Array<EventType>) —

    Types of Events to return

  • :from (Time) —

    Starting date for search in YYYY-MM-DDThh:mm:ss format.

  • :to (Time) —

    Ending date for search in YYYY-MM-DDThh:mm:ss format.

  • :order_by (EventsOrderBy) — default: default to 'DateDescending'
  • :limit (Integer) —

    How many items to load. Maximum for this request is 1000 items

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

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

    Array<RecipientEvent> data, response status code and response headers



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/ElasticEmail/api/events_api.rb', line 488

def events_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_get ...'
  end
  # resource path
  local_var_path = '/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'eventTypes'] = @api_client.build_collection_param(opts[:'event_types'], :multi) if !opts[:'event_types'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<RecipientEvent>'

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

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