Class: Lockally::ContactListsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lockally/api/contact_lists_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactListsApi

Returns a new instance of ContactListsApi.



19
20
21
 
# File 'lib/lockally/api/contact_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/lockally/api/contact_lists_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_contact_list_member(id, add_contact_list_member_request, opts = {}) ⇒ nil

Add a member to a contact list

Parameters:

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/lockally/api/contact_lists_api.rb', line 27

def add_contact_list_member(id, add_contact_list_member_request, opts = {})
  add_contact_list_member_with_http_info(id, add_contact_list_member_request, opts)
  nil
end

#add_contact_list_member_with_http_info(id, add_contact_list_member_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add a member to a contact list

Parameters:

Returns:

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

    nil, 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
84
85
86
87
88
89
90
91
92
 
# File 'lib/lockally/api/contact_lists_api.rb', line 37

def add_contact_list_member_with_http_info(id, add_contact_list_member_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListsApi.add_contact_list_member ...'
  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 ContactListsApi.add_contact_list_member"
  end
  # verify the required parameter 'add_contact_list_member_request' is set
  if @api_client.config.client_side_validation && add_contact_list_member_request.nil?
    fail ArgumentError, "Missing the required parameter 'add_contact_list_member_request' when calling ContactListsApi.add_contact_list_member"
  end
  # resource path
  local_var_path = '/v1/contact-lists/{id}/members'.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/problem+json']) unless header_params['Accept']
  # 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(add_contact_list_member_request)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#create_contact_list(create_contact_list_request, opts = {}) ⇒ ContactList

Create a contact list

Parameters:

Returns:



98
99
100
101
 
# File 'lib/lockally/api/contact_lists_api.rb', line 98

def create_contact_list(create_contact_list_request, opts = {})
  data, _status_code, _headers = create_contact_list_with_http_info(create_contact_list_request, opts)
  data
end

#create_contact_list_with_http_info(create_contact_list_request, opts = {}) ⇒ Array<(ContactList, Integer, Hash)>

Create a contact list

Parameters:

Returns:

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

    ContactList data, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/lockally/api/contact_lists_api.rb', line 107

def create_contact_list_with_http_info(create_contact_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListsApi.create_contact_list ...'
  end
  # verify the required parameter 'create_contact_list_request' is set
  if @api_client.config.client_side_validation && create_contact_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_contact_list_request' when calling ContactListsApi.create_contact_list"
  end
  # resource path
  local_var_path = '/v1/contact-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', 'application/problem+json']) unless header_params['Accept']
  # 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(create_contact_list_request)

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

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

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

#delete_contact_list(id, opts = {}) ⇒ nil

Delete a contact list

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


164
165
166
167
 
# File 'lib/lockally/api/contact_lists_api.rb', line 164

def delete_contact_list(id, opts = {})
  delete_contact_list_with_http_info(id, opts)
  nil
end

#delete_contact_list_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a contact list

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/lockally/api/contact_lists_api.rb', line 173

def delete_contact_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListsApi.delete_contact_list ...'
  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 ContactListsApi.delete_contact_list"
  end
  # resource path
  local_var_path = '/v1/contact-lists/{id}'.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/problem+json']) unless header_params['Accept']

  # 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] || ['bearerAuth']

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

#get_contact_list(id, opts = {}) ⇒ GetContactList200Response

Get a contact list with members

Parameters:

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

    the optional parameters

Returns:



225
226
227
228
 
# File 'lib/lockally/api/contact_lists_api.rb', line 225

def get_contact_list(id, opts = {})
  data, _status_code, _headers = get_contact_list_with_http_info(id, opts)
  data
end

#get_contact_list_with_http_info(id, opts = {}) ⇒ Array<(GetContactList200Response, Integer, Hash)>

Get a contact list with members

Parameters:

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

    the optional parameters

Returns:

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

    GetContactList200Response data, response status code and response headers



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
273
274
275
276
277
278
279
280
 
# File 'lib/lockally/api/contact_lists_api.rb', line 234

def get_contact_list_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListsApi.get_contact_list ...'
  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 ContactListsApi.get_contact_list"
  end
  # resource path
  local_var_path = '/v1/contact-lists/{id}'.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', 'application/problem+json']) unless header_params['Accept']

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

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

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

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

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

#list_contact_lists(opts = {}) ⇒ ListContactLists200Response

List contact lists

Parameters:

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/lockally/api/contact_lists_api.rb', line 285

def list_contact_lists(opts = {})
  data, _status_code, _headers = list_contact_lists_with_http_info(opts)
  data
end

#list_contact_lists_with_http_info(opts = {}) ⇒ Array<(ListContactLists200Response, Integer, Hash)>

List contact lists

Parameters:

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

    the optional parameters

Returns:

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

    ListContactLists200Response data, response status code and response headers



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
 
# File 'lib/lockally/api/contact_lists_api.rb', line 293

def list_contact_lists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListsApi.list_contact_lists ...'
  end
  # resource path
  local_var_path = '/v1/contact-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', 'application/problem+json']) unless header_params['Accept']

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

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

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

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

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

#remove_contact_list_member(id, contact_id, opts = {}) ⇒ nil

Remove a member from a contact list

Parameters:

  • id (String)
  • contact_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


342
343
344
345
 
# File 'lib/lockally/api/contact_lists_api.rb', line 342

def remove_contact_list_member(id, contact_id, opts = {})
  remove_contact_list_member_with_http_info(id, contact_id, opts)
  nil
end

#remove_contact_list_member_with_http_info(id, contact_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a member from a contact list

Parameters:

  • id (String)
  • contact_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/lockally/api/contact_lists_api.rb', line 352

def remove_contact_list_member_with_http_info(id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListsApi.remove_contact_list_member ...'
  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 ContactListsApi.remove_contact_list_member"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactListsApi.remove_contact_list_member"
  end
  # resource path
  local_var_path = '/v1/contact-lists/{id}/members/{contactId}'.sub('{id}', CGI.escape(id.to_s)).sub('{contactId}', CGI.escape(contact_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/problem+json']) unless header_params['Accept']

  # 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] || ['bearerAuth']

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

#update_contact_list(id, update_contact_list_request, opts = {}) ⇒ ContactList

Update a contact list

Parameters:

  • id (String)
  • update_contact_list_request (UpdateContactListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



409
410
411
412
 
# File 'lib/lockally/api/contact_lists_api.rb', line 409

def update_contact_list(id, update_contact_list_request, opts = {})
  data, _status_code, _headers = update_contact_list_with_http_info(id, update_contact_list_request, opts)
  data
end

#update_contact_list_with_http_info(id, update_contact_list_request, opts = {}) ⇒ Array<(ContactList, Integer, Hash)>

Update a contact list

Parameters:

  • id (String)
  • update_contact_list_request (UpdateContactListRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ContactList data, response status code and response headers



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
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/lockally/api/contact_lists_api.rb', line 419

def update_contact_list_with_http_info(id, update_contact_list_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactListsApi.update_contact_list ...'
  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 ContactListsApi.update_contact_list"
  end
  # verify the required parameter 'update_contact_list_request' is set
  if @api_client.config.client_side_validation && update_contact_list_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_contact_list_request' when calling ContactListsApi.update_contact_list"
  end
  # resource path
  local_var_path = '/v1/contact-lists/{id}'.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', 'application/problem+json']) unless header_params['Accept']
  # 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(update_contact_list_request)

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

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

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