module OnSIP::UserAddress::ClassMethods

Public Instance Methods

add(user, attrs = {}) { |response| ... } click to toggle source
# File lib/onsip/models/user_address.rb, line 45
def add(user, attrs = {})
  params = { 'Username' => user.attributes.Username,
             'Domain' => user.attributes.Domain,
             'Timeout' => DEFAULT_CALL_TIMEOUT }.merge(attrs)

  params = params.merge({ 'Action' => 'UserAddressAdd',
                          'SessionId' => OnSIP.session.id,
                          'OrganizationId' => user.organization_id,
                          'UserId' => user.id,
                          'Output' => 'json' })

  response = OnSIP.connection.get('/api', params, {})
  yield response if block_given?
  process_add_user_address_response response
end
browse(args) { |response| ... } click to toggle source
# File lib/onsip/models/user_address.rb, line 28
def browse(args)
  params = args.merge({'Action' => 'UserAddressBrowse', 'SessionId' => OnSIP.session.id, 'Output' => 'json'})
  response = OnSIP.connection.get('/api', params, {})
  yield response if block_given?
  process_browse_user_address_response response
end
delete!(*args) click to toggle source

TODO

# File lib/onsip/models/user_address.rb, line 101
def delete!(*args)
  raise NotImplementedError
end
edit(*args) click to toggle source

TODO

# File lib/onsip/models/user_address.rb, line 96
def edit(*args)
  raise NotImplementedError
end
process_add_user_address_response(response) click to toggle source
# File lib/onsip/models/user_address.rb, line 61
def process_add_user_address_response(response)
  address = nil

  key_path = %w(Response Result UserAddressAdd UserAddress)
  a = ResponseParser.parse_response response, key_path
  address = (a.map { |h| new h }).first if a

  address
end
process_browse_user_address_response(response) click to toggle source
# File lib/onsip/models/user_address.rb, line 35
def process_browse_user_address_response(response)
  addresses = []

  key_path = %w(Response Result UserAddressBrowse UserAddresses UserAddress)
  a = ResponseParser.parse_response response, key_path
  addresses = a.map { |h| new h } if a

  addresses
end
process_read_user_address_response(response) click to toggle source
# File lib/onsip/models/user_address.rb, line 85
def process_read_user_address_response(response)
  user = nil

  key_path = %w(Response Result UserAddressRead UserAddress)
  a = ResponseParser.parse_response response, key_path
  user = (a.map { |h| new h }).first if a

  user
end
read(address) { |response| ... } click to toggle source

Read a UserAddress

reference at developer.onsip.com/admin-api/User-Addresses/#user-address-read

@example UserAddress.read UserAddress.read(address)

@return [ UserAddress ] The found UserAddress.

# File lib/onsip/models/user_address.rb, line 79
def read(address)
  response = OnSIP.connection.get('/api', {'Action' => 'UserAddressRead', 'SessionId' => OnSIP.session.id, 'Address' => address, 'Output' => 'json'}, {})
  yield response if block_given?
  process_read_user_address_response response
end