Class: PhoneComClient::ContactsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phone_com_client/api/contacts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactsApi

Returns a new instance of ContactsApi.



19
20
21
 
# File 'lib/phone_com_client/api/contacts_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/phone_com_client/api/contacts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_account_extension_contact(account_id, extension_id, opts = {}) ⇒ ContactFull

Add a new address book contact for an extension. Add a new address book contact for an extension. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

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

    the optional parameters

Options Hash (opts):

Returns:



29
30
31
32
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 29

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

#create_account_extension_contact_with_http_info(account_id, extension_id, opts = {}) ⇒ Array<(ContactFull, Fixnum, Hash)>

Add a new address book contact for an extension. Add a new address book contact for an extension. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ContactFull data, response status code and response headers



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/phone_com_client/api/contacts_api.rb', line 41

def (, extension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.create_account_extension_contact ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ContactsApi.create_account_extension_contact"
  end
  # verify the required parameter 'extension_id' is set
  if @api_client.config.client_side_validation && extension_id.nil?
    fail ArgumentError, "Missing the required parameter 'extension_id' when calling ContactsApi.create_account_extension_contact"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/contacts'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'extension_id' + '}', extension_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(opts[:'data'])
  auth_names = ['apiKey']
  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 => 'ContactFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#create_account_extension_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_extension_contact(account_id, extension_id, contact_id, opts = {}) ⇒ DeleteEntry

Delete a contact from the address book. Delete a contact from the address book. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 91

def (, extension_id, contact_id, opts = {})
  data, _status_code, _headers = (, extension_id, contact_id, opts)
  data
end

#delete_account_extension_contact_with_http_info(account_id, extension_id, contact_id, opts = {}) ⇒ Array<(DeleteEntry, Fixnum, Hash)>

Delete a contact from the address book. Delete a contact from the address book. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:

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

    DeleteEntry data, response status code and response headers



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
147
148
149
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 103

def (, extension_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.delete_account_extension_contact ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ContactsApi.delete_account_extension_contact"
  end
  # verify the required parameter 'extension_id' is set
  if @api_client.config.client_side_validation && extension_id.nil?
    fail ArgumentError, "Missing the required parameter 'extension_id' when calling ContactsApi.delete_account_extension_contact"
  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 ContactsApi.delete_account_extension_contact"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'extension_id' + '}', extension_id.to_s).sub('{' + 'contact_id' + '}', contact_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 = ['apiKey']
  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 => 'DeleteEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#delete_account_extension_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_extension_contact(account_id, extension_id, contact_id, opts = {}) ⇒ ContactFull

Retrieve the details of an address book contact. Retrieve the details of an address book contact. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:



157
158
159
160
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 157

def (, extension_id, contact_id, opts = {})
  data, _status_code, _headers = (, extension_id, contact_id, opts)
  data
end

#get_account_extension_contact_with_http_info(account_id, extension_id, contact_id, opts = {}) ⇒ Array<(ContactFull, Fixnum, Hash)>

Retrieve the details of an address book contact. Retrieve the details of an address book contact. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:

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

    ContactFull data, response status code and response headers



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
210
211
212
213
214
215
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 169

def (, extension_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.get_account_extension_contact ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ContactsApi.get_account_extension_contact"
  end
  # verify the required parameter 'extension_id' is set
  if @api_client.config.client_side_validation && extension_id.nil?
    fail ArgumentError, "Missing the required parameter 'extension_id' when calling ContactsApi.get_account_extension_contact"
  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 ContactsApi.get_account_extension_contact"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'extension_id' + '}', extension_id.to_s).sub('{' + 'contact_id' + '}', contact_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 = ['apiKey']
  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 => 'ContactFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#get_account_extension_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_extension_contacts(account_id, extension_id, opts = {}) ⇒ ListContacts

Show the Caller ID options a given extension can use. Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :filters_group_id (Array<String>) —

    Group filter

  • :filters_updated_at (Array<String>) —

    Updated At filter

  • :sort_id (String) —

    ID sorting

  • :sort_updated_at (String) —

    Updated At sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:



230
231
232
233
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 230

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

#list_account_extension_contacts_with_http_info(account_id, extension_id, opts = {}) ⇒ Array<(ListContacts, Fixnum, Hash)>

Show the Caller ID options a given extension can use. Show the Caller ID options a given extension can use. See Intro to Caller IDs for more on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :filters_group_id (Array<String>) —

    Group filter

  • :filters_updated_at (Array<String>) —

    Updated At filter

  • :sort_id (String) —

    ID sorting

  • :sort_updated_at (String) —

    Updated At sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:

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

    ListContacts data, response status code and response headers



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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 249

def (, extension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.list_account_extension_contacts ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ContactsApi.list_account_extension_contacts"
  end
  # verify the required parameter 'extension_id' is set
  if @api_client.config.client_side_validation && extension_id.nil?
    fail ArgumentError, "Missing the required parameter 'extension_id' when calling ContactsApi.list_account_extension_contacts"
  end
  if @api_client.config.client_side_validation && !opts[:'sort_id'].nil? && opts[:'sort_id'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_id\"]' when calling ContactsApi.list_account_extension_contacts, must conform to the pattern /asc|desc/."
  end

  if @api_client.config.client_side_validation && !opts[:'sort_updated_at'].nil? && opts[:'sort_updated_at'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_updated_at\"]' when calling ContactsApi.list_account_extension_contacts, must conform to the pattern /asc|desc/."
  end

  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/contacts'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'extension_id' + '}', extension_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'filters[id]'] = @api_client.build_collection_param(opts[:'filters_id'], :multi) if !opts[:'filters_id'].nil?
  query_params[:'filters[group_id]'] = @api_client.build_collection_param(opts[:'filters_group_id'], :multi) if !opts[:'filters_group_id'].nil?
  query_params[:'filters[updated_at]'] = @api_client.build_collection_param(opts[:'filters_updated_at'], :multi) if !opts[:'filters_updated_at'].nil?
  query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil?
  query_params[:'sort[updated_at]'] = opts[:'sort_updated_at'] if !opts[:'sort_updated_at'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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 = ['apiKey']
  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 => 'ListContacts')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#list_account_extension_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_account_extension_contact(account_id, extension_id, contact_id, opts = {}) ⇒ ContactFull

Update the info of a contact in the address book. Update the info of a contact in the address book. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • contact_id —

    Contact ID

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

    the optional parameters

Options Hash (opts):

Returns:



316
317
318
319
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 316

def (, extension_id, contact_id, opts = {})
  data, _status_code, _headers = (, extension_id, contact_id, opts)
  data
end

#replace_account_extension_contact_with_http_info(account_id, extension_id, contact_id, opts = {}) ⇒ Array<(ContactFull, Fixnum, Hash)>

Update the info of a contact in the address book. Update the info of a contact in the address book. See Account Contacts for more info on the fields in each item.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • contact_id —

    Contact ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ContactFull 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
 
# File 'lib/phone_com_client/api/contacts_api.rb', line 329

def (, extension_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactsApi.replace_account_extension_contact ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ContactsApi.replace_account_extension_contact"
  end
  # verify the required parameter 'extension_id' is set
  if @api_client.config.client_side_validation && extension_id.nil?
    fail ArgumentError, "Missing the required parameter 'extension_id' when calling ContactsApi.replace_account_extension_contact"
  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 ContactsApi.replace_account_extension_contact"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/contacts/{contact_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'extension_id' + '}', extension_id.to_s).sub('{' + 'contact_id' + '}', contact_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(opts[:'data'])
  auth_names = ['apiKey']
  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 => 'ContactFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContactsApi#replace_account_extension_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end