class PhoneComClient::ListenersApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/phone_com_client/api/listeners_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_account_listener(account_id, opts = {}) click to toggle source

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 @param account_id Account ID @param [Hash] opts the optional parameters @option opts [CreateListenerParams] :data Account Listeners Data @return [ListenerFull]

# File lib/phone_com_client/api/listeners_api.rb, line 28
def create_account_listener(account_id, opts = {})
  data, _status_code, _headers = create_account_listener_with_http_info(account_id, opts)
  data
end
create_account_listener_with_http_info(account_id, opts = {}) click to toggle source

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 @param account_id Account ID @param [Hash] opts the optional parameters @option opts [CreateListenerParams] :data Account Listeners Data @return [Array<(ListenerFull, Fixnum, Hash)>] ListenerFull data, response status code and response headers

# File lib/phone_com_client/api/listeners_api.rb, line 39
def create_account_listener_with_http_info(account_id, 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 && account_id.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' + '}', 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 = {}) click to toggle source

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 @param account_id Account ID @param listener_id Listener ID @param [Hash] opts the optional parameters @return [DeleteEntry]

# File lib/phone_com_client/api/listeners_api.rb, line 84
def delete_account_listener(account_id, listener_id, opts = {})
  data, _status_code, _headers = delete_account_listener_with_http_info(account_id, listener_id, opts)
  data
end
delete_account_listener_with_http_info(account_id, listener_id, opts = {}) click to toggle source

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 @param account_id Account ID @param listener_id Listener ID @param [Hash] opts the optional parameters @return [Array<(DeleteEntry, Fixnum, Hash)>] DeleteEntry data, response status code and response headers

# File lib/phone_com_client/api/listeners_api.rb, line 95
def delete_account_listener_with_http_info(account_id, 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 && account_id.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' + '}', 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 = {}) click to toggle source

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 @param account_id Account ID @param listener_id Listener ID @param [Hash] opts the optional parameters @return [ListenerFull]

# File lib/phone_com_client/api/listeners_api.rb, line 144
def get_account_listener(account_id, listener_id, opts = {})
  data, _status_code, _headers = get_account_listener_with_http_info(account_id, listener_id, opts)
  data
end
get_account_listener_with_http_info(account_id, listener_id, opts = {}) click to toggle source

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 @param account_id Account ID @param listener_id Listener ID @param [Hash] opts the optional parameters @return [Array<(ListenerFull, Fixnum, Hash)>] ListenerFull data, response status code and response headers

# File lib/phone_com_client/api/listeners_api.rb, line 155
def get_account_listener_with_http_info(account_id, 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 && account_id.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' + '}', 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 = {}) click to toggle source

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 @param account_id Account ID @param [Hash] opts the optional parameters @option opts [Array<String>] :filters_id ID filter @option opts [String] :sort_id ID sorting @option opts [Integer] :limit Max results @option opts [Integer] :offset Results to skip @option opts [String] :fields Field set @return [ListListeners]

# File lib/phone_com_client/api/listeners_api.rb, line 208
def list_account_listeners(account_id, opts = {})
  data, _status_code, _headers = list_account_listeners_with_http_info(account_id, opts)
  data
end
list_account_listeners_with_http_info(account_id, opts = {}) click to toggle source

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 @param account_id Account ID @param [Hash] opts the optional parameters @option opts [Array<String>] :filters_id ID filter @option opts [String] :sort_id ID sorting @option opts [Integer] :limit Max results @option opts [Integer] :offset Results to skip @option opts [String] :fields Field set @return [Array<(ListListeners, Fixnum, Hash)>] ListListeners data, response status code and response headers

# File lib/phone_com_client/api/listeners_api.rb, line 223
def list_account_listeners_with_http_info(account_id, 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 && account_id.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' + '}', 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 = {}) click to toggle source

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 @param account_id Account ID @param listener_id Listener ID @param [Hash] opts the optional parameters @option opts [CreateListenerParams] :data Account Listeners Data @return [ListenerFull]

# File lib/phone_com_client/api/listeners_api.rb, line 278
def replace_account_listener(account_id, listener_id, opts = {})
  data, _status_code, _headers = replace_account_listener_with_http_info(account_id, listener_id, opts)
  data
end
replace_account_listener_with_http_info(account_id, listener_id, opts = {}) click to toggle source

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 @param account_id Account ID @param listener_id Listener ID @param [Hash] opts the optional parameters @option opts [CreateListenerParams] :data Account Listeners Data @return [Array<(ListenerFull, Fixnum, Hash)>] ListenerFull data, response status code and response headers

# File lib/phone_com_client/api/listeners_api.rb, line 290
def replace_account_listener_with_http_info(account_id, 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 && account_id.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' + '}', 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