Class: ElasticEmail::EmailsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailsApi

Returns a new instance of EmailsApi.



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

def api_client
  @api_client
end

Instance Method Details

#emails_by_msgid_view_get(msgid, opts = {}) ⇒ EmailData

View Email Returns email details for viewing or rendering. Required Access Level: None

Parameters:

  • msgid (String) —

    Message identifier

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

    the optional parameters

Returns:



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

def emails_by_msgid_view_get(msgid, opts = {})
  data, _status_code, _headers = emails_by_msgid_view_get_with_http_info(msgid, opts)
  data
end

#emails_by_msgid_view_get_with_http_info(msgid, opts = {}) ⇒ Array<(EmailData, Integer, Hash)>

View Email Returns email details for viewing or rendering. Required Access Level: None

Parameters:

  • msgid (String) —

    Message identifier

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

    the optional parameters

Returns:

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

    EmailData 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/emails_api.rb', line 37

def emails_by_msgid_view_get_with_http_info(msgid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailsApi.emails_by_msgid_view_get ...'
  end
  # verify the required parameter 'msgid' is set
  if @api_client.config.client_side_validation && msgid.nil?
    fail ArgumentError, "Missing the required parameter 'msgid' when calling EmailsApi.emails_by_msgid_view_get"
  end
  # resource path
  local_var_path = '/emails/{msgid}/view'.sub('{' + 'msgid' + '}', CGI.escape(msgid.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] || 'EmailData'

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

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

#emails_by_transactionid_status_get(transactionid, opts = {}) ⇒ EmailJobStatus

Get Status Get status details of an email transaction. Required Access Level: ViewReports

Parameters:

  • transactionid (String) —

    Transaction identifier

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

    the optional parameters

Options Hash (opts):

  • :show_failed (Boolean) —

    Include Bounced email addresses. (default to false)

  • :show_sent (Boolean) —

    Include Sent email addresses. (default to false)

  • :show_delivered (Boolean) —

    Include all delivered email addresses. (default to false)

  • :show_pending (Boolean) —

    Include Ready to send email addresses. (default to false)

  • :show_opened (Boolean) —

    Include Opened email addresses. (default to false)

  • :show_clicked (Boolean) —

    Include Clicked email addresses. (default to false)

  • :show_abuse (Boolean) —

    Include Reported as abuse email addresses. (default to false)

  • :show_unsubscribed (Boolean) —

    Include Unsubscribed email addresses. (default to false)

  • :show_errors (Boolean) —

    Include error messages for bounced emails. (default to false)

  • :show_message_ids (Boolean) —

    Include all MessageIDs for this transaction (default to false)

Returns:



100
101
102
103
 
# File 'lib/ElasticEmail/api/emails_api.rb', line 100

def emails_by_transactionid_status_get(transactionid, opts = {})
  data, _status_code, _headers = emails_by_transactionid_status_get_with_http_info(transactionid, opts)
  data
end

#emails_by_transactionid_status_get_with_http_info(transactionid, opts = {}) ⇒ Array<(EmailJobStatus, Integer, Hash)>

Get Status Get status details of an email transaction. Required Access Level: ViewReports

Parameters:

  • transactionid (String) —

    Transaction identifier

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

    the optional parameters

Options Hash (opts):

  • :show_failed (Boolean) —

    Include Bounced email addresses. (default to false)

  • :show_sent (Boolean) —

    Include Sent email addresses. (default to false)

  • :show_delivered (Boolean) —

    Include all delivered email addresses. (default to false)

  • :show_pending (Boolean) —

    Include Ready to send email addresses. (default to false)

  • :show_opened (Boolean) —

    Include Opened email addresses. (default to false)

  • :show_clicked (Boolean) —

    Include Clicked email addresses. (default to false)

  • :show_abuse (Boolean) —

    Include Reported as abuse email addresses. (default to false)

  • :show_unsubscribed (Boolean) —

    Include Unsubscribed email addresses. (default to false)

  • :show_errors (Boolean) —

    Include error messages for bounced emails. (default to false)

  • :show_message_ids (Boolean) —

    Include all MessageIDs for this transaction (default to false)

Returns:

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

    EmailJobStatus data, response status code and response headers



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

def emails_by_transactionid_status_get_with_http_info(transactionid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailsApi.emails_by_transactionid_status_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 EmailsApi.emails_by_transactionid_status_get"
  end
  # resource path
  local_var_path = '/emails/{transactionid}/status'.sub('{' + 'transactionid' + '}', CGI.escape(transactionid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'showFailed'] = opts[:'show_failed'] if !opts[:'show_failed'].nil?
  query_params[:'showSent'] = opts[:'show_sent'] if !opts[:'show_sent'].nil?
  query_params[:'showDelivered'] = opts[:'show_delivered'] if !opts[:'show_delivered'].nil?
  query_params[:'showPending'] = opts[:'show_pending'] if !opts[:'show_pending'].nil?
  query_params[:'showOpened'] = opts[:'show_opened'] if !opts[:'show_opened'].nil?
  query_params[:'showClicked'] = opts[:'show_clicked'] if !opts[:'show_clicked'].nil?
  query_params[:'showAbuse'] = opts[:'show_abuse'] if !opts[:'show_abuse'].nil?
  query_params[:'showUnsubscribed'] = opts[:'show_unsubscribed'] if !opts[:'show_unsubscribed'].nil?
  query_params[:'showErrors'] = opts[:'show_errors'] if !opts[:'show_errors'].nil?
  query_params[:'showMessageIDs'] = opts[:'show_message_ids'] if !opts[:'show_message_ids'].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] || 'EmailJobStatus'

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

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

#emails_mergefile_post(merge_email_payload, opts = {}) ⇒ EmailSend

Send Bulk Emails CSV Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using merge tags in the content. Example CSV: email, firstname, lastname [email protected], michael, smith [email protected], janet, smith Merge file must not be empty. Required Access Level: SendHttp

Parameters:

  • merge_email_payload (MergeEmailPayload) —

    Email data

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

    the optional parameters

Returns:



183
184
185
186
 
# File 'lib/ElasticEmail/api/emails_api.rb', line 183

def emails_mergefile_post(merge_email_payload, opts = {})
  data, _status_code, _headers = emails_mergefile_post_with_http_info(merge_email_payload, opts)
  data
end

#emails_mergefile_post_with_http_info(merge_email_payload, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>

Send Bulk Emails CSV Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using merge tags in the content. Example CSV: email, firstname, lastname [email protected], michael, smith [email protected], janet, smith Merge file must not be empty. Required Access Level: SendHttp

Parameters:

  • merge_email_payload (MergeEmailPayload) —

    Email data

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

    the optional parameters

Returns:

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

    EmailSend data, response status code and response headers



193
194
195
196
197
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
241
242
243
244
 
# File 'lib/ElasticEmail/api/emails_api.rb', line 193

def emails_mergefile_post_with_http_info(merge_email_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailsApi.emails_mergefile_post ...'
  end
  # verify the required parameter 'merge_email_payload' is set
  if @api_client.config.client_side_validation && merge_email_payload.nil?
    fail ArgumentError, "Missing the required parameter 'merge_email_payload' when calling EmailsApi.emails_mergefile_post"
  end
  # resource path
  local_var_path = '/emails/mergefile'

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

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

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

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

#emails_post(email_message_data, opts = {}) ⇒ EmailSend

Send Bulk Emails Send bulk merge email. Required Access Level: SendHttp

Parameters:

  • email_message_data (EmailMessageData) —

    Email data

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

    the optional parameters

Returns:



251
252
253
254
 
# File 'lib/ElasticEmail/api/emails_api.rb', line 251

def emails_post(email_message_data, opts = {})
  data, _status_code, _headers = emails_post_with_http_info(email_message_data, opts)
  data
end

#emails_post_with_http_info(email_message_data, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>

Send Bulk Emails Send bulk merge email. Required Access Level: SendHttp

Parameters:

  • email_message_data (EmailMessageData) —

    Email data

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

    the optional parameters

Returns:

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

    EmailSend data, response status code and response headers



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/ElasticEmail/api/emails_api.rb', line 261

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

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

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

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

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

#emails_transactional_post(email_transactional_message_data, opts = {}) ⇒ EmailSend

Send Transactional Email Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp

Parameters:

Returns:



319
320
321
322
 
# File 'lib/ElasticEmail/api/emails_api.rb', line 319

def emails_transactional_post(email_transactional_message_data, opts = {})
  data, _status_code, _headers = emails_transactional_post_with_http_info(email_transactional_message_data, opts)
  data
end

#emails_transactional_post_with_http_info(email_transactional_message_data, opts = {}) ⇒ Array<(EmailSend, Integer, Hash)>

Send Transactional Email Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp

Parameters:

Returns:

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

    EmailSend data, response status code and response headers



329
330
331
332
333
334
335
336
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
380
 
# File 'lib/ElasticEmail/api/emails_api.rb', line 329

def emails_transactional_post_with_http_info(email_transactional_message_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailsApi.emails_transactional_post ...'
  end
  # verify the required parameter 'email_transactional_message_data' is set
  if @api_client.config.client_side_validation && email_transactional_message_data.nil?
    fail ArgumentError, "Missing the required parameter 'email_transactional_message_data' when calling EmailsApi.emails_transactional_post"
  end
  # resource path
  local_var_path = '/emails/transactional'

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

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

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

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