Class: ElasticEmail::ListsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ListsApi

Returns a new instance of ListsApi.



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

def api_client
  @api_client
end

Instance Method Details

#lists_by_name_contacts_post(name, emails_payload, opts = {}) ⇒ ContactsList

Add Contacts to List Add existing Contacts to specified list. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

  • emails_payload (EmailsPayload) —

    Provide either rule or a list of emails, not both.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 28

def lists_by_name_contacts_post(name, emails_payload, opts = {})
  data, _status_code, _headers = lists_by_name_contacts_post_with_http_info(name, emails_payload, opts)
  data
end

#lists_by_name_contacts_post_with_http_info(name, emails_payload, opts = {}) ⇒ Array<(ContactsList, Integer, Hash)>

Add Contacts to List Add existing Contacts to specified list. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

  • emails_payload (EmailsPayload) —

    Provide either rule or a list of emails, not both.

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

    the optional parameters

Returns:

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

    ContactsList data, response status code and response headers



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
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 39

def lists_by_name_contacts_post_with_http_info(name, emails_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListsApi.lists_by_name_contacts_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 ListsApi.lists_by_name_contacts_post"
  end
  # verify the required parameter 'emails_payload' is set
  if @api_client.config.client_side_validation && emails_payload.nil?
    fail ArgumentError, "Missing the required parameter 'emails_payload' when calling ListsApi.lists_by_name_contacts_post"
  end
  # resource path
  local_var_path = '/lists/{name}/contacts'.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'])
  # 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(emails_payload)

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

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

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

#lists_by_name_contacts_remove_post(name, emails_payload, opts = {}) ⇒ nil

Remove Contacts from List Remove specified Contacts from your list. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

  • emails_payload (EmailsPayload) —

    Provide either rule or a list of emails, not both.

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

    the optional parameters

Returns:

  • (nil) 


102
103
104
105
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 102

def lists_by_name_contacts_remove_post(name, emails_payload, opts = {})
  lists_by_name_contacts_remove_post_with_http_info(name, emails_payload, opts)
  nil
end

#lists_by_name_contacts_remove_post_with_http_info(name, emails_payload, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove Contacts from List Remove specified Contacts from your list. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

  • emails_payload (EmailsPayload) —

    Provide either rule or a list of emails, not both.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 113

def lists_by_name_contacts_remove_post_with_http_info(name, emails_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListsApi.lists_by_name_contacts_remove_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 ListsApi.lists_by_name_contacts_remove_post"
  end
  # verify the required parameter 'emails_payload' is set
  if @api_client.config.client_side_validation && emails_payload.nil?
    fail ArgumentError, "Missing the required parameter 'emails_payload' when calling ListsApi.lists_by_name_contacts_remove_post"
  end
  # resource path
  local_var_path = '/lists/{name}/contacts/remove'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(emails_payload)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#lists_by_name_delete(name, opts = {}) ⇒ nil

Delete List Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

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

    the optional parameters

Returns:

  • (nil) 


173
174
175
176
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 173

def lists_by_name_delete(name, opts = {})
  lists_by_name_delete_with_http_info(name, opts)
  nil
end

#lists_by_name_delete_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete List Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 183

def lists_by_name_delete_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListsApi.lists_by_name_delete ...'
  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 ListsApi.lists_by_name_delete"
  end
  # resource path
  local_var_path = '/lists/{name}'.sub('{' + 'name' + '}', CGI.escape(name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"ListsApi.lists_by_name_delete",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListsApi#lists_by_name_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_by_name_get(name, opts = {}) ⇒ ContactsList

Load List Returns detailed information about specified list. Required Access Level: ViewContacts

Parameters:

  • name (String) —

    Name of your list.

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

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 234

def lists_by_name_get(name, opts = {})
  data, _status_code, _headers = lists_by_name_get_with_http_info(name, opts)
  data
end

#lists_by_name_get_with_http_info(name, opts = {}) ⇒ Array<(ContactsList, Integer, Hash)>

Load List Returns detailed information about specified list. Required Access Level: ViewContacts

Parameters:

  • name (String) —

    Name of your list.

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

    the optional parameters

Returns:

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

    ContactsList data, response status code and response headers



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

def lists_by_name_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListsApi.lists_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 ListsApi.lists_by_name_get"
  end
  # resource path
  local_var_path = '/lists/{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] || 'ContactsList'

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

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

#lists_by_name_put(name, list_update_payload, opts = {}) ⇒ ContactsList

Update List Update existing list. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

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

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 298

def lists_by_name_put(name, list_update_payload, opts = {})
  data, _status_code, _headers = lists_by_name_put_with_http_info(name, list_update_payload, opts)
  data
end

#lists_by_name_put_with_http_info(name, list_update_payload, opts = {}) ⇒ Array<(ContactsList, Integer, Hash)>

Update List Update existing list. Required Access Level: ModifyContacts

Parameters:

  • name (String) —

    Name of your list.

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

    the optional parameters

Returns:

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

    ContactsList data, response status code and response headers



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

def lists_by_name_put_with_http_info(name, list_update_payload, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListsApi.lists_by_name_put ...'
  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 ListsApi.lists_by_name_put"
  end
  # verify the required parameter 'list_update_payload' is set
  if @api_client.config.client_side_validation && list_update_payload.nil?
    fail ArgumentError, "Missing the required parameter 'list_update_payload' when calling ListsApi.lists_by_name_put"
  end
  # resource path
  local_var_path = '/lists/{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'])
  # 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(list_update_payload)

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

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

  new_options = opts.merge(
    :operation => :"ListsApi.lists_by_name_put",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListsApi#lists_by_name_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_get(opts = {}) ⇒ Array<ContactsList>

Load Lists Returns all your existing lists. Required Access Level: ViewContacts

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:



372
373
374
375
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 372

def lists_get(opts = {})
  data, _status_code, _headers = lists_get_with_http_info(opts)
  data
end

#lists_get_with_http_info(opts = {}) ⇒ Array<(Array<ContactsList>, Integer, Hash)>

Load Lists Returns all your existing lists. Required Access Level: ViewContacts

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<ContactsList>, Integer, Hash)>) —

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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 383

def lists_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListsApi.lists_get ...'
  end
  # resource path
  local_var_path = '/lists'

  # 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<ContactsList>'

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

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

#lists_post(list_payload, opts = {}) ⇒ ContactsList

Add List Add a new list. Required Access Level: ModifyContacts

Parameters:

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

    the optional parameters

Returns:



434
435
436
437
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 434

def lists_post(list_payload, opts = {})
  data, _status_code, _headers = lists_post_with_http_info(list_payload, opts)
  data
end

#lists_post_with_http_info(list_payload, opts = {}) ⇒ Array<(ContactsList, Integer, Hash)>

Add List Add a new list. Required Access Level: ModifyContacts

Parameters:

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

    the optional parameters

Returns:

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

    ContactsList data, response status code and response headers



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/ElasticEmail/api/lists_api.rb', line 444

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

  # 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(list_payload)

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

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

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