Class: ClickSendClient::ContactListApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/contact_list_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactListApi

Returns a new instance of ContactListApi.



19
20
21
 
# File 'lib/clicksend_client/api/contact_list_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/clicksend_client/api/contact_list_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#lists_by_list_id_delete(list_id, opts = {}) ⇒ String

ListsByListIdDelete Delete a specific contact list

Parameters:

  • list_id —

    List ID

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 27

def lists_by_list_id_delete(list_id, opts = {})
  data, _status_code, _headers = lists_by_list_id_delete_with_http_info(list_id, opts)
  data
end

#lists_by_list_id_delete_with_http_info(list_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

ListsByListIdDelete Delete a specific contact list

Parameters:

  • list_id —

    List ID

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String 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
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 37

def lists_by_list_id_delete_with_http_info(list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListApi.lists_by_list_id_delete ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactListApi.lists_by_list_id_delete"
  end
  # resource path
  local_var_path = '/lists/{list_id}'.sub('{' + 'list_id' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactListApi#lists_by_list_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_by_list_id_get(list_id, opts = {}) ⇒ String

Get specific contact list Get specific contact list

Parameters:

  • list_id —

    List ID

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

    the optional parameters

Returns:

  • (String) 


81
82
83
84
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 81

def lists_by_list_id_get(list_id, opts = {})
  data, _status_code, _headers = lists_by_list_id_get_with_http_info(list_id, opts)
  data
end

#lists_by_list_id_get_with_http_info(list_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get specific contact list Get specific contact list

Parameters:

  • list_id —

    List ID

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



91
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
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 91

def lists_by_list_id_get_with_http_info(list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListApi.lists_by_list_id_get ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactListApi.lists_by_list_id_get"
  end
  # resource path
  local_var_path = '/lists/{list_id}'.sub('{' + 'list_id' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactListApi#lists_by_list_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_by_list_id_put(list_id, contact_list, opts = {}) ⇒ String

Update specific contact list Update specific contact list

Parameters:

  • list_id —

    Your list id

  • contact_list —

    Contact list model

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

    the optional parameters

Returns:

  • (String) 


136
137
138
139
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 136

def lists_by_list_id_put(list_id, contact_list, opts = {})
  data, _status_code, _headers = lists_by_list_id_put_with_http_info(list_id, contact_list, opts)
  data
end

#lists_by_list_id_put_with_http_info(list_id, contact_list, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Update specific contact list Update specific contact list

Parameters:

  • list_id —

    Your list id

  • contact_list —

    Contact list model

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 147

def lists_by_list_id_put_with_http_info(list_id, contact_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListApi.lists_by_list_id_put ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactListApi.lists_by_list_id_put"
  end
  # verify the required parameter 'contact_list' is set
  if @api_client.config.client_side_validation && contact_list.nil?
    fail ArgumentError, "Missing the required parameter 'contact_list' when calling ContactListApi.lists_by_list_id_put"
  end
  # resource path
  local_var_path = '/lists/{list_id}'.sub('{' + 'list_id' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(contact_list)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactListApi#lists_by_list_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_get(opts = {}) ⇒ String

Get all contact lists Get all contact lists

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


196
197
198
199
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 196

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

#lists_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get all contact lists Get all contact lists

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
245
246
247
248
249
250
251
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 207

def lists_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListApi.lists_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ContactListApi.lists_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactListApi.lists_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/lists'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactListApi#lists_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_import_by_list_id_post(list_id, file, opts = {}) ⇒ String

Import contacts to list Import contacts to list

Parameters:

  • list_id —

    Your contact list id you want to access.

  • file —

    ContactListImport model

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

    the optional parameters

Returns:

  • (String) 


258
259
260
261
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 258

def lists_import_by_list_id_post(list_id, file, opts = {})
  data, _status_code, _headers = lists_import_by_list_id_post_with_http_info(list_id, file, opts)
  data
end

#lists_import_by_list_id_post_with_http_info(list_id, file, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Import contacts to list Import contacts to list

Parameters:

  • list_id —

    Your contact list id you want to access.

  • file —

    ContactListImport model

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 269

def lists_import_by_list_id_post_with_http_info(list_id, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListApi.lists_import_by_list_id_post ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactListApi.lists_import_by_list_id_post"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling ContactListApi.lists_import_by_list_id_post"
  end
  # resource path
  local_var_path = '/lists/{list_id}/import'.sub('{' + 'list_id' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(file)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactListApi#lists_import_by_list_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_post(contact_list, opts = {}) ⇒ String

Create new contact list Create new contact list

Parameters:

  • contact_list —

    Contact list model

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

    the optional parameters

Returns:

  • (String) 


317
318
319
320
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 317

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

#lists_post_with_http_info(contact_list, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Create new contact list Create new contact list

Parameters:

  • contact_list —

    Contact list model

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
365
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 327

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(contact_list)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactListApi#lists_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lists_remove_duplicates_by_list_id_put(list_id, fields, opts = {}) ⇒ String

Remove duplicate contacts Remove duplicate contacts

Parameters:

  • list_id —

    Your list id

  • fields —

    Fields model

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

    the optional parameters

Returns:

  • (String) 


372
373
374
375
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 372

def lists_remove_duplicates_by_list_id_put(list_id, fields, opts = {})
  data, _status_code, _headers = lists_remove_duplicates_by_list_id_put_with_http_info(list_id, fields, opts)
  data
end

#lists_remove_duplicates_by_list_id_put_with_http_info(list_id, fields, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Remove duplicate contacts Remove duplicate contacts

Parameters:

  • list_id —

    Your list id

  • fields —

    Fields model

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String 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
 
# File 'lib/clicksend_client/api/contact_list_api.rb', line 383

def lists_remove_duplicates_by_list_id_put_with_http_info(list_id, fields, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListApi.lists_remove_duplicates_by_list_id_put ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactListApi.lists_remove_duplicates_by_list_id_put"
  end
  # verify the required parameter 'fields' is set
  if @api_client.config.client_side_validation && fields.nil?
    fail ArgumentError, "Missing the required parameter 'fields' when calling ContactListApi.lists_remove_duplicates_by_list_id_put"
  end
  # resource path
  local_var_path = '/lists/{list_id}/remove-duplicates'.sub('{' + 'list_id' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(fields)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactListApi#lists_remove_duplicates_by_list_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end