class RubyRedtail::User::Settings

Public Class Methods

new(api_hash) click to toggle source
# File lib/ruby-redtail/user/settings.rb, line 7
def initialize api_hash
  @api_hash = api_hash
end

Public Instance Methods

activitytypes() click to toggle source

Activity Type List Fetch returns a list of activity types with the corresponding Activity Code

# File lib/ruby-redtail/user/settings.rb, line 13
def activitytypes
  build_settings_array RubyRedtail::Query.run("settings/activitytypes", @api_hash, "GET")
end
csl(deleted=false) click to toggle source

Contact Status List Fetch returns a list of contact statuses with the corresponding Contact Status Code. optional Parameter: {deleted}* {0} shows current records, {1} shows deleted records

# File lib/ruby-redtail/user/settings.rb, line 45
def csl(deleted=false)
  build_settings_array RubyRedtail::Query.run("settings/csl?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
end
mccl(deleted=false) click to toggle source

Contact Category List Fetch returns a list of Contact Categories with the corresponding Contact Category Code optional Parameter: {deleted}* {0} shows current records, {1} shows deleted records

# File lib/ruby-redtail/user/settings.rb, line 53
def mccl(deleted=false)
  build_settings_array RubyRedtail::Query.run("settings/mccl?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
end
mcl() click to toggle source

Master Category List Fetch returns a Master Category List with the corresponding MCL Code.

# File lib/ruby-redtail/user/settings.rb, line 19
def mcl
  build_settings_array RubyRedtail::Query.run("settings/mcl", @api_hash, "GET")
end
mcsl(deleted=false) click to toggle source

Contact Source List Fetch returns a list of Contact Sources with the corresponding Contact Source Code optional Parameter: {deleted}* {0} shows current records, {1} shows deleted records

# File lib/ruby-redtail/user/settings.rb, line 61
def mcsl(deleted=false)
  build_settings_array RubyRedtail::Query.run("settings/mcsl?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
end
sal(deleted=false) click to toggle source

Servicing Advisor List Fetch returns a list of Servicing Advisors with the corresponding Servicing Advisor Code. optional Parameter: {deleted}* {0} shows current records, {1} shows deleted records

# File lib/ruby-redtail/user/settings.rb, line 69
def sal(deleted=false)
  build_settings_array RubyRedtail::Query.run("settings/sal?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
end
salutations() click to toggle source

Salutation List Fetch returns a list of Salutations with the corresponding Salutation Code

# File lib/ruby-redtail/user/settings.rb, line 25
def salutations
  build_settings_array RubyRedtail::Query.run("settings/salutations", @api_hash, "GET")
end
tag_groups() click to toggle source

Tag Groups Fetch returns a list of Tag Groups for a user’s Database.

# File lib/ruby-redtail/user/settings.rb, line 37
def tag_groups
  build_tag_groups_array RubyRedtail::Query.run("settings/taggroups", @api_hash, "GET")
end
udf() click to toggle source

User-Defined Fields Fetch returns a list of User-defined fields with the corresponding UDF Code.

# File lib/ruby-redtail/user/settings.rb, line 31
def udf
  build_settings_array RubyRedtail::Query.run("settings/udf", @api_hash, "GET")
end
wal(deleted=false) click to toggle source

Writing Advisor List Fetch returns a list of Writing Advisors with the corresponding Writing Advisor Code. optional Parameter: {deleted}* {0} shows current records, {1} shows deleted records

# File lib/ruby-redtail/user/settings.rb, line 77
def wal(deleted=false)
  build_settings_array RubyRedtail::Query.run("settings/wal?deleted=#{deleted ? 1 : 0}", @api_hash, "GET")
end

Protected Instance Methods

build_setting(setting_hash) click to toggle source
# File lib/ruby-redtail/user/settings.rb, line 83
def build_setting setting_hash
  RubyRedtail::Setting.new(setting_hash,@api_hash)
end
build_settings_array(setting_hashes) click to toggle source
# File lib/ruby-redtail/user/settings.rb, line 87
def build_settings_array setting_hashes
  if setting_hashes
    setting_hashes.collect { |setting_hash| self.build_setting setting_hash }
  else
    raise RubyRedtail::AuthenticationError
  end
end
build_tag_group(tag_group_hash) click to toggle source
# File lib/ruby-redtail/user/settings.rb, line 95
def build_tag_group tag_group_hash
  RubyRedtail::Taggroup.new(tag_group_hash,@api_hash)
end
build_tag_groups_array(tag_group_hashes) click to toggle source
# File lib/ruby-redtail/user/settings.rb, line 99
def build_tag_groups_array tag_group_hashes
  if tag_group_hashes
    tag_group_hashes.collect { |tag_group_hash| self.build_tag_group tag_group_hash }
  else
    raise RubyRedtail::AuthenticationError
  end
end