Class: ElasticEmail::StatisticsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatisticsApi

Returns a new instance of StatisticsApi.



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

def api_client
  @api_client
end

Instance Method Details

#statistics_campaigns_by_name_get(name, opts = {}) ⇒ ChannelLogStatusSummary

Load Campaign Stats Retrieve stats of an existing campaign. Required Access Level: ViewChannels

Parameters:

  • name (String) —

    The name of the campaign to get.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 27

def statistics_campaigns_by_name_get(name, opts = {})
  data, _status_code, _headers = statistics_campaigns_by_name_get_with_http_info(name, opts)
  data
end

#statistics_campaigns_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(ChannelLogStatusSummary, Integer, Hash)>

Load Campaign Stats Retrieve stats of an existing campaign. Required Access Level: ViewChannels

Parameters:

  • name (String) —

    The name of the campaign to get.

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

    the optional parameters

Returns:

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

    ChannelLogStatusSummary data, response status code and response headers



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
76
77
78
79
80
81
82
83
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 37

def statistics_campaigns_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_campaigns_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 StatisticsApi.statistics_campaigns_by_name_get"
  end
  # resource path
  local_var_path = '/statistics/campaigns/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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] || 'ChannelLogStatusSummary'

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

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

#statistics_campaigns_get(opts = {}) ⇒ Array<ChannelLogStatusSummary>

Load Campaigns Stats Returns a list of your Campaigns' stats. Required Access Level: ViewChannels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



91
92
93
94
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 91

def statistics_campaigns_get(opts = {})
  data, _status_code, _headers = statistics_campaigns_get_with_http_info(opts)
  data
end

#statistics_campaigns_get_with_http_info(opts = {}) ⇒ Array<(Array<ChannelLogStatusSummary>, Integer, Hash)>

Load Campaigns Stats Returns a list of your Campaigns&#39; stats. Required Access Level: ViewChannels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

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

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



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
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 102

def statistics_campaigns_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_campaigns_get ...'
  end
  # resource path
  local_var_path = '/statistics/campaigns'

  # query parameters
  query_params = opts[:query_params] || {}
  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<ChannelLogStatusSummary>'

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

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

#statistics_channels_by_name_get(name, opts = {}) ⇒ ChannelLogStatusSummary

Load Channel Stats Retrieve an existing channel stats. Required Access Level: ViewChannels

Parameters:

  • name (String) —

    The name of the channel to get.

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

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 153

def statistics_channels_by_name_get(name, opts = {})
  data, _status_code, _headers = statistics_channels_by_name_get_with_http_info(name, opts)
  data
end

#statistics_channels_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(ChannelLogStatusSummary, Integer, Hash)>

Load Channel Stats Retrieve an existing channel stats. Required Access Level: ViewChannels

Parameters:

  • name (String) —

    The name of the channel to get.

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

    the optional parameters

Returns:

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

    ChannelLogStatusSummary data, response status code and response headers



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
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 163

def statistics_channels_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_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 StatisticsApi.statistics_channels_by_name_get"
  end
  # resource path
  local_var_path = '/statistics/channels/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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] || 'ChannelLogStatusSummary'

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

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

#statistics_channels_get(opts = {}) ⇒ Array<ChannelLogStatusSummary>

Load Channels Stats Returns a list of your Channels' stats. Required Access Level: ViewChannels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:



217
218
219
220
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 217

def statistics_channels_get(opts = {})
  data, _status_code, _headers = statistics_channels_get_with_http_info(opts)
  data
end

#statistics_channels_get_with_http_info(opts = {}) ⇒ Array<(Array<ChannelLogStatusSummary>, Integer, Hash)>

Load Channels Stats Returns a list of your Channels&#39; stats. Required Access Level: ViewChannels

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Maximum number of returned items.

  • :offset (Integer) —

    How many items should be returned ahead.

Returns:

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

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



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
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 228

def statistics_channels_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_channels_get ...'
  end
  # resource path
  local_var_path = '/statistics/channels'

  # query parameters
  query_params = opts[:query_params] || {}
  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<ChannelLogStatusSummary>'

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

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

#statistics_get(from, opts = {}) ⇒ LogStatusSummary

Load Statistics Returns basic statistics. Required Access Level: ViewReports

Parameters:

  • from (Time) —

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

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

    the optional parameters

Options Hash (opts):

  • :to (Time) —

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

Returns:



280
281
282
283
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 280

def statistics_get(from, opts = {})
  data, _status_code, _headers = statistics_get_with_http_info(from, opts)
  data
end

#statistics_get_with_http_info(from, opts = {}) ⇒ Array<(LogStatusSummary, Integer, Hash)>

Load Statistics Returns basic statistics. Required Access Level: ViewReports

Parameters:

  • from (Time) —

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

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

    the optional parameters

Options Hash (opts):

  • :to (Time) —

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

Returns:

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

    LogStatusSummary data, response status code and response headers



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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/ElasticEmail/api/statistics_api.rb', line 291

def statistics_get_with_http_info(from, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatisticsApi.statistics_get ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling StatisticsApi.statistics_get"
  end
  # resource path
  local_var_path = '/statistics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = from
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].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] || 'LogStatusSummary'

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

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