Class: PhoneComClient::ListenersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ListenersApi

Returns a new instance of ListenersApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_account_listener(account_id, opts = {}) ⇒ ListenerFull

Add a listener object to your account that can be used to subscribe an event. Add a listener object to your account that can be used to subscribe an event. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Post Listener API with the following definition: POST api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

Returns:



28
29
30
31
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 28

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

#create_account_listener_with_http_info(account_id, opts = {}) ⇒ Array<(ListenerFull, Fixnum, Hash)>

Add a listener object to your account that can be used to subscribe an event. Add a listener object to your account that can be used to subscribe an event. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Post Listener API with the following definition: POST api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ListenerFull 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
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 39

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ListenersApi.create_account_listener ...'
  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 ListenersApi.create_account_listener"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/listeners'.sub('{' + 'account_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 => 'ListenerFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListenersApi#create_account_listener\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_listener(account_id, listener_id, opts = {}) ⇒ DeleteEntry

Delete an individual event listener. Delete an individual event listener. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Delete Listener API with the following definition: DELETE api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id

Parameters:

  • account_id —

    Account ID

  • listener_id —

    Listener ID

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 84

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

#delete_account_listener_with_http_info(account_id, listener_id, opts = {}) ⇒ Array<(DeleteEntry, Fixnum, Hash)>

Delete an individual event listener. Delete an individual event listener. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Delete Listener API with the following definition: DELETE api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id

Parameters:

  • account_id —

    Account ID

  • listener_id —

    Listener ID

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

    the optional parameters

Returns:

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

    DeleteEntry data, response status code and response headers



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
130
131
132
133
134
135
136
137
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 95

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

#get_account_listener(account_id, listener_id, opts = {}) ⇒ ListenerFull

Show details of an individual listener. Show details of an individual event listener. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Get Listener API with the following definition: GET api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id

Parameters:

  • account_id —

    Account ID

  • listener_id —

    Listener ID

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

    the optional parameters

Returns:



144
145
146
147
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 144

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

#get_account_listener_with_http_info(account_id, listener_id, opts = {}) ⇒ Array<(ListenerFull, Fixnum, Hash)>

Show details of an individual listener. Show details of an individual event listener. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Get Listener API with the following definition: GET api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id

Parameters:

  • account_id —

    Account ID

  • listener_id —

    Listener ID

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

    the optional parameters

Returns:

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

    ListenerFull data, response status code and response headers



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
190
191
192
193
194
195
196
197
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 155

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

#list_account_listeners(account_id, opts = {}) ⇒ ListListeners

Get a list of listeners for an account. Get a list of listeners for an account. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List Listeners API with the following definition: GET api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :sort_id (String) —

    ID sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:



208
209
210
211
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 208

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

#list_account_listeners_with_http_info(account_id, opts = {}) ⇒ Array<(ListListeners, Fixnum, Hash)>

Get a list of listeners for an account. Get a list of listeners for an account. See Account Listeners for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List Listeners API with the following definition: GET api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :sort_id (String) —

    ID sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:

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

    ListListeners data, response status code and response headers



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 223

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

  # resource path
  local_var_path = '/accounts/{account_id}/listeners'.sub('{' + 'account_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[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].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 => 'ListListeners')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListenersApi#list_account_listeners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_account_listener(account_id, listener_id, opts = {}) ⇒ ListenerFull

Update the settings of an individual event listener. Update the settings of an individual event listener. See Event Listeners for more detail. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Replace Listener API with the following definition: PUT api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id

Parameters:

  • account_id —

    Account ID

  • listener_id —

    Listener ID

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

    the optional parameters

Options Hash (opts):

Returns:



278
279
280
281
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 278

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

#replace_account_listener_with_http_info(account_id, listener_id, opts = {}) ⇒ Array<(ListenerFull, Fixnum, Hash)>

Update the settings of an individual event listener. Update the settings of an individual event listener. See Event Listeners for more detail. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level Replace Listener API with the following definition: PUT api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners/:listener_id

Parameters:

  • account_id —

    Account ID

  • listener_id —

    Listener ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ListenerFull data, response status code and response headers



290
291
292
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
 
# File 'lib/phone_com_client/api/listeners_api.rb', line 290

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