Class: PhoneComClient::GroupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupsApi

Returns a new instance of GroupsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_account_extension_contact_group(account_id, extension_id, data, opts = {}) ⇒ GroupFull

Add a new contact group to an account extension. Add a new contact group to an account extension. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • data —

    Group data

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

    the optional parameters

Returns:



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

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

#create_account_extension_contact_group_with_http_info(account_id, extension_id, data, opts = {}) ⇒ Array<(GroupFull, Fixnum, Hash)>

Add a new contact group to an account extension. Add a new contact group to an account extension. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • data —

    Group data

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

    the optional parameters

Returns:

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

    GroupFull 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
84
85
86
87
 
# File 'lib/phone_com_client/api/groups_api.rb', line 41

def (, extension_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.create_account_extension_contact_group ...'
  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 GroupsApi.create_account_extension_contact_group"
  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 GroupsApi.create_account_extension_contact_group"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling GroupsApi.create_account_extension_contact_group"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/contact-groups'.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(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 => 'GroupFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#create_account_extension_contact_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_extension_contact_group(account_id, extension_id, group_id, opts = {}) ⇒ DeleteEntry

Delete a contact group from the address book. Delete a contact group from the address book. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • group_id —

    Group ID

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/phone_com_client/api/groups_api.rb', line 95

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

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

Delete a contact group from the address book. Delete a contact group from the address book. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • group_id —

    Group ID

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

    the optional parameters

Returns:

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

    DeleteEntry 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
 
# File 'lib/phone_com_client/api/groups_api.rb', line 107

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

#get_account_extension_contact_group(account_id, extension_id, group_id, opts = {}) ⇒ GroupFull

Retrieve the information of a contact group. Retrieve the information of a contact group. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • group_id —

    Group ID

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

    the optional parameters

Returns:



161
162
163
164
 
# File 'lib/phone_com_client/api/groups_api.rb', line 161

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

#get_account_extension_contact_group_with_http_info(account_id, extension_id, group_id, opts = {}) ⇒ Array<(GroupFull, Fixnum, Hash)>

Retrieve the information of a contact group. Retrieve the information of a contact group. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • group_id —

    Group ID

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

    the optional parameters

Returns:

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

    GroupFull data, 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/phone_com_client/api/groups_api.rb', line 173

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

#list_account_extension_contact_groups(account_id, extension_id, opts = {}) ⇒ ListGroups

Show a list of contact groups belonging to an extension. Show a list of contact groups belonging to an extension. See Account Contact Groups for details 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_name (Array<String>) —

    Name filter

  • :sort_id (String) —

    ID sorting

  • :sort_name (String) —

    Name sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:



233
234
235
236
 
# File 'lib/phone_com_client/api/groups_api.rb', line 233

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

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

Show a list of contact groups belonging to an extension. Show a list of contact groups belonging to an extension. See Account Contact Groups for details 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_name (Array<String>) —

    Name filter

  • :sort_id (String) —

    ID sorting

  • :sort_name (String) —

    Name sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:

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

    ListGroups data, response status code and response headers



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
308
 
# File 'lib/phone_com_client/api/groups_api.rb', line 251

def (, extension_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.list_account_extension_contact_groups ...'
  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 GroupsApi.list_account_extension_contact_groups"
  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 GroupsApi.list_account_extension_contact_groups"
  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 GroupsApi.list_account_extension_contact_groups, must conform to the pattern /asc|desc/."
  end

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

  # resource path
  local_var_path = '/accounts/{account_id}/extensions/{extension_id}/contact-groups'.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[name]'] = @api_client.build_collection_param(opts[:'filters_name'], :multi) if !opts[:'filters_name'].nil?
  query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil?
  query_params[:'sort[name]'] = opts[:'sort_name'] if !opts[:'sort_name'].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 => 'ListGroups')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupsApi#list_account_extension_contact_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_account_extension_contact_group(account_id, extension_id, group_id, data, opts = {}) ⇒ GroupFull

Update the information of a contact group. Update the information of a contact group. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • group_id —

    Group ID

  • data —

    Group data

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

    the optional parameters

Returns:



317
318
319
320
 
# File 'lib/phone_com_client/api/groups_api.rb', line 317

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

#replace_account_extension_contact_group_with_http_info(account_id, extension_id, group_id, data, opts = {}) ⇒ Array<(GroupFull, Fixnum, Hash)>

Update the information of a contact group. Update the information of a contact group. See Account Contact Groups for details on the properties.

Parameters:

  • account_id —

    Account ID

  • extension_id —

    Extension ID

  • group_id —

    Group ID

  • data —

    Group data

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

    the optional parameters

Returns:

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

    GroupFull data, response status code and response headers



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

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