softlayer_api 3.0.2 → 3.1.0

data/lib/softlayer/SoftwarePassword.rb

@@ -14,15 +14,29 @@ module SoftLayer
   #
   class SoftwarePassword < ModelBase
     include ::SoftLayer::DynamicAttribute
+
+    ##
+    # :attr_reader: created_at
+    # The date this username/password pair was created.
+    sl_attr :created_at, 'createDate'
     
     ##
-    # :attr_reader:
+    # :attr_reader: created
     # The date this username/password pair was created.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of created_at
+    # and will be removed in the next major release.
     sl_attr :created, 'createDate'
 
     ##
-    # :attr_reader:
+    # :attr_reader: modified_at
     # The date of the last modification to this username/password pair.
+    sl_attr :modified_at, 'modifyDate'
+
+    ##
+    # :attr_reader: modified
+    # The date of the last modification to this username/password pair.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of modified_at
+    # and will be removed in the next major release.
     sl_attr :modified, 'modifyDate'
 
     ##
@@ -65,10 +79,17 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # You may filter the list returned by adding options:
-    # * <b>+:datacenter+</b>    (string) - Include software passwords from application delivery controllers matching this datacenter
-    # * <b>+:name+</b>          (string) - Include software passwords from application delivery controllers that matches this name
-    # * <b>+:tags+</b>          (Array)  - Include software passwords from application delivery controllers that matches these tags
-    # * <b>+:username+</b>      (string) - Include software passwords that match this username
+    # * <b>+:datacenter+</b> (string/array) - Include software passwords from application delivery controllers matching this datacenter
+    # * <b>+:name+</b>       (string/array) - Include software passwords from application delivery controllers that matches this name
+    # * <b>+:tags+</b>       (string/array  - Include software passwords from application delivery controllers that matches these tags
+    # * <b>+:username+</b>   (string/array) - Include software passwords that match this username
+    #
+    # Additionally you may provide options related to the request itself:
+    # * <b>*:application_delivery_controller_object_filter*</b> (ObjectFilter) - Include software passwords from application delivery controllers
+    #                                                                            that matches the criteria of this object filter
+    # * <b>*:software_password_object_filter*</b>               (ObjectFilter) - Include software passwords that match the criteria of this object filter
+    # * <b>*:software_password_object_mask*</b>                 (string)       - The object mask of properties you wish to receive for the items returned.
+    #                                                                            If not provided, the result will use the default object mask
     #
     def self.find_passwords_for_application_delivery_controllers(options_hash = {})
       softlayer_client = options_hash[:client] || Client.default_client
@@ -89,34 +110,27 @@ module SoftLayer
       end
 
       option_to_filter_path = {
-        :advanced_mode     => "applicationDeliveryControllers.advancedModeFlag",
-        :datacenter        => "applicationDeliveryControllers.datacenter.name",
-        :name              => "applicationDeliveryControllers.name",
-        :tags              => "applicationDeliveryControllers.tagReferences.tag.name",
-        :software_password => {
+        :app_deliv_controller => {
+          :advanced_mode     => "applicationDeliveryControllers.advancedModeFlag",
+          :datacenter        => "applicationDeliveryControllers.datacenter.name",
+          :name              => "applicationDeliveryControllers.name",
+          :tags              => "applicationDeliveryControllers.tagReferences.tag.name"
+        },
+        :software_password    => {
           :username        => "password.username"
         }
       }
 
-      application_delivery_controller_object_filter.modify { |filter| filter.accept(option_to_filter_path[:advanced_mode]).when_it is(true) }
+      application_delivery_controller_object_filter.modify { |filter| filter.accept(option_to_filter_path[:app_deliv_controller][:advanced_mode]).when_it is(true) }
+
+      option_to_filter_path[:app_deliv_controller].each do |option, filter_path|
+        next if option == :advanced_mode
 
-      [ :datacenter, :name ].each do |option|
         if options_hash[option]
-          application_delivery_controller_object_filter.modify { |filter| filter.accept(option_to_filter_path[option]).when_it is(options_hash[option]) }
+          application_delivery_controller_object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option]) }
         end
       end
 
-      if options_hash[:tags]
-        application_delivery_controller_object_filter.set_criteria_for_key_path(option_to_filter_path[:tags],
-                                                                                {
-                                                                                  'operation' => 'in',
-                                                                                  'options' => [{
-                                                                                                  'name' => 'data',
-                                                                                                  'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-                                                                                                }]
-                                                                                })
-      end
-
       option_to_filter_path[:software_password].each do |option, filter_path|
         software_password_object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option]) } if options_hash[option]
       end
@@ -150,15 +164,24 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # You may filter the list returned by adding options:
-    # * <b>+:datacenter+</b>    (string) - Include software passwords from vlan firewalls matching this datacenter
-    # * <b>+:vlan_name+</b>     (Array)  - Include software passwords from vlans that matches these names
-    # * <b>+:vlan_numbers+</b>  (Array)  - Include software passwords from vlans that matches these numbers
-    # * <b>+:vlan_space+</b>    (symbol) - Include software passwords from vlans that match this space
-    # * <b>+:vlan_tags+</b>     (Array)  - Include software passwords from vlans that matches these tags
-    # * <b>+:vlan_fw_fqdn+</b>  (string) - Include software passwords from vlan firewalls that match this fqdn
-    # * <b>+:vlan_fw_tags+</b>  (Array)  - Include software passwords from vlan firewalls that matches these tags
-    # * <b>+:vlan_fw_type+</b>  (string) - Include software passwords from vlan firewalls that match this type
-    # * <b>+:username+</b>      (string) - Include software passwords that match this username
+    # * <b>+:datacenter+</b>    (string/array) - Include software passwords from vlan firewalls matching this datacenter
+    # * <b>+:vlan_names+</b>    (string/array) - Include software passwords from vlans that matches these names
+    # * <b>+:vlan_numbers+</b>  (string/array) - Include software passwords from vlans that matches these numbers
+    # * <b>+:vlan_space+</b>    (symbol)       - Include software passwords from vlans that match this space
+    # * <b>+:vlan_tags+</b>     (string/array) - Include software passwords from vlans that matches these tags
+    # * <b>+:vlan_fw_fqdn+</b>  (string/array) - Include software passwords from vlan firewalls that match this fqdn
+    # * <b>+:vlan_fw_tags+</b>  (string/array) - Include software passwords from vlan firewalls that matches these tags
+    # * <b>+:vlan_fw_type+</b>  (string/array) - Include software passwords from vlan firewalls that match this type
+    # * <b>+:username+</b>      (string/array) - Include software passwords that match this username
+    #
+    # Additionally you may provide options related to the request itself:
+    # * <b>*:software_password_object_filter*</b> (ObjectFilter) - Include software passwords that match the criteria of this object filter
+    # * <b>*:software_password_object_mask*</b>   (string)       - The object mask of properties you wish to receive for the items returned.
+    #                                                              If not provided, the result will use the default object mask
+    # * <b>*:vlan_firewall_object_filter*</b>     (ObjectFilter) - Include software passwords from vlan firewalls that match the
+    #                                                              criteria of this object filter
+    # * <b>*:vlan_object_filter*</b>              (ObjectFilter) - Include software passwords from vlan firewalls whose vlans match the
+    #                                                              criteria of this object filter
     #
     def self.find_passwords_for_vlan_firewalls(options_hash = {})
       softlayer_client = options_hash[:client] || Client.default_client
@@ -195,16 +218,18 @@ module SoftLayer
         :software_password => {
           :username        => "managementCredentials.username"
           },
-        :vlan_dedicated_fw => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'dedicatedFirewallFlag' ].join  },
-        :vlan_names        => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'name' ].join                   },
-        :vlan_numbers      => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'vlanNumber' ].join             },
-        :vlan_tags         => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'tagReferences.tag.name' ].join },
+        :vlan              => {
+          :vlan_dedicated_fw => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'dedicatedFirewallFlag' ].join  },
+          :vlan_names        => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'name' ].join                   },
+          :vlan_numbers      => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'vlanNumber' ].join             },
+          :vlan_tags         => lambda { |vlan_space| return [ filter_label[vlan_space], '.', 'tagReferences.tag.name' ].join }
+        },
         :vlan_firewall     => {
           :vlan_fw_datacenter => "networkVlanFirewall.datacenter.name",
           :vlan_fw_fqdn       => "networkVlanFirewall.fullyQualifiedDomainName",
+          :vlan_fw_tags       => "networkVlanFirewall.tagReferences.tag.name",
           :vlan_fw_type       => "networkVlanFirewall.firewallType"
-        },
-        :vlan_fw_tags      => "networkVlanFirewall.tagReferences.tag.name"
+        }
       }
 
       if options_hash[:vlan_space] && ! filter_label.keys.include?(options_hash[:vlan_space])
@@ -217,19 +242,11 @@ module SoftLayer
 
       vlan_space = options_hash[:vlan_space] || :all
 
-      vlan_object_filter.modify { |filter| filter.accept(option_to_filter_path[:vlan_dedicated_fw].call(vlan_space)).when_it is(1) }
-      vlan_object_filter.modify { |filter| filter.accept(option_to_filter_path[:vlan_name].call(vlan_space)).when_it is(options_hash[:vlan_name]) } if options_hash[:vlan_name]
+      option_to_filter_path[:vlan].keys.each do |option|
+        vlan_object_filter.modify { |filter| filter.accept(option_to_filter_path[:vlan][option].call(vlan_space)).when_it is(1) } if option == :vlan_dedicated_fw
 
-      [ :vlan_names, :vlan_numbers, :vlan_tags ].each do |option|
-        if options_hash[option]
-          vlan_object_filter.set_criteria_for_key_path(option_to_filter_path[option].call(vlan_space),
-                                                       {
-                                                         'operation' => 'in',
-                                                         'options' => [{
-                                                                         'name' => 'data',
-                                                                         'value' => options_hash[option].collect{ |tag_value| tag_value.to_s }
-                                                                       }]
-                                                     })
+        if options_hash[option] && option != :vlan_dedicated_fw
+          vlan_object_filter.modify { |filter| filter.accept(option_to_filter_path[:vlan][option].call(vlan_space)).when_it is(options_hash[option]) }
         end
       end
 
@@ -237,17 +254,6 @@ module SoftLayer
         vlan_firewall_object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option]) } if options_hash[option]
       end
 
-      if options_hash[:vlan_fw_tags]
-        vlan_firewall_object_filter.set_criteria_for_key_path(option_to_filter_path[:vlan_fw_tags],
-                                                              {
-                                                                'operation' => 'in',
-                                                                'options' => [{
-                                                                                'name' => 'data',
-                                                                                'value' => options_hash[:vlan_fw_tags].collect{ |tag_value| tag_value.to_s }
-                                                                              }]
-                                                              })
-      end
-
       account_service = softlayer_client[:Account]
       account_service = account_service.object_filter(vlan_object_filter) unless vlan_object_filter.empty?
       account_service = account_service.object_mask("mask[id]")
@@ -293,14 +299,14 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # You may filter the list returned by adding options:
-    # * <b>+:datacenter+</b>    (string) - Include software passwords from software on hardware matching this datacenter
-    # * <b>+:description+</b>   (string) - Include software passwords from software that matches this description
-    # * <b>+:domain+</b>        (string) - Include software passwords from software on hardware matching this domain
-    # * <b>+:hardware_type+</b> (string) - Include software passwords from software on hardware matching this hardware type
-    # * <b>+:hostname+</b>      (string) - Include software passwords from software on hardware matching this hostname
-    # * <b>+:manufacturer+</b>  (string) - Include software passwords from software that matches this manufacturer
-    # * <b>+:name+</b>          (string) - Include software passwords from software that matches this name
-    # * <b>+:username+</b>      (string) - Include software passwords for username matching this username
+    # * <b>+:datacenter+</b>    (string/array) - Include software passwords from software on hardware matching this datacenter
+    # * <b>+:description+</b>   (string/array) - Include software passwords from software that matches this description
+    # * <b>+:domain+</b>        (string/array) - Include software passwords from software on hardware matching this domain
+    # * <b>+:hardware_type+</b> (symbol)       - Include software passwords from software on hardware matching this hardware type
+    # * <b>+:hostname+</b>      (string/array) - Include software passwords from software on hardware matching this hostname
+    # * <b>+:manufacturer+</b>  (string/array) - Include software passwords from software that matches this manufacturer
+    # * <b>+:name+</b>          (string/array) - Include software passwords from software that matches this name
+    # * <b>+:username+</b>      (string/array) - Include software passwords for username matching this username
     #
     # You may use the following properties to provide hardware or software object filter instances:
     # * <b>+:hardware_object_filter+</b>          (ObjectFilter) - Include software passwords from software on hardware that matches the criteria of this object filter
@@ -341,10 +347,12 @@ module SoftLayer
       }
 
       option_to_filter_path = {
-        :datacenter        => lambda { |hardware_type| return [ filter_label[hardware_type], '.datacenter.name' ].join        },
-        :domain            => lambda { |hardware_type| return [ filter_label[hardware_type], '.domain' ].join                 },
-        :hostname          => lambda { |hardware_type| return [ filter_label[hardware_type], '.hostname' ].join               },
-        :tags              => lambda { |hardware_type| return [ filter_label[hardware_type], '.tagReferences.tag.name' ].join },
+        :hardware          => {
+          :datacenter        => lambda { |hardware_type| return [ filter_label[hardware_type], '.datacenter.name' ].join        },
+          :domain            => lambda { |hardware_type| return [ filter_label[hardware_type], '.domain' ].join                 },
+          :hostname          => lambda { |hardware_type| return [ filter_label[hardware_type], '.hostname' ].join               },
+          :tags              => lambda { |hardware_type| return [ filter_label[hardware_type], '.tagReferences.tag.name' ].join }
+        },
         :software          => {
           :description     => "softwareComponents.softwareDescription.longDescription",
           :manufacturer    => "softwareComponents.softwareDescription.manufacturer",
@@ -362,23 +370,12 @@ module SoftLayer
         end
       end
 
-      [ :datacenter, :domain, :hostname ].each do |option|
+      option_to_filter_path[:hardware].keys.each do |option|
         if options_hash[option]
-          hardware_object_filter.modify { |filter| filter.accept(option_to_filter_path[option].call(options_hash[:hardware_type] || :hardware)).when_it is(options_hash[option]) }
+          hardware_object_filter.modify { |filter| filter.accept(option_to_filter_path[:hardware][option].call(options_hash[:hardware_type] || :hardware)).when_it is(options_hash[option]) }
         end
       end
 
-      if options_hash[:tags]
-        hardware_object_filter.set_criteria_for_key_path(option_to_filter_path[:tags].call(options_hash[:hardware_type] || :hardware),
-                                                         {
-                                                           'operation' => 'in',
-                                                           'options' => [{
-                                                                           'name' => 'data',
-                                                                           'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-                                                                         }]
-                                                         })
-      end
-
       option_to_filter_path[:software].each do |option, filter_path|
         software_object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option]) } if options_hash[option]
       end
@@ -436,13 +433,13 @@ module SoftLayer
     # If no client can be found the routine will raise an error.
     #
     # You may filter the list returned by adding options:
-    # * <b>+:datacenter+</b>    (string) - Include software passwords from software on virtual servers matching this datacenter
-    # * <b>+:description+</b>   (string) - Include software passwords from software that matches this description
-    # * <b>+:domain+</b>        (string) - Include software passwords from software on virtual servers matching this domain
-    # * <b>+:hostname+</b>      (string) - Include software passwords from software on virtual servers matching this hostname
-    # * <b>+:manufacturer+</b>  (string) - Include software passwords from software that matches this manufacturer
-    # * <b>+:name+</b>          (string) - Include software passwords from software that matches this name
-    # * <b>+:username+</b>      (string) - Include software passwords for username matching this username
+    # * <b>+:datacenter+</b>    (string/array) - Include software passwords from software on virtual servers matching this datacenter
+    # * <b>+:description+</b>   (string/array) - Include software passwords from software that matches this description
+    # * <b>+:domain+</b>        (string/array) - Include software passwords from software on virtual servers matching this domain
+    # * <b>+:hostname+</b>      (string/array) - Include software passwords from software on virtual servers matching this hostname
+    # * <b>+:manufacturer+</b>  (string/array) - Include software passwords from software that matches this manufacturer
+    # * <b>+:name+</b>          (string/array) - Include software passwords from software that matches this name
+    # * <b>+:username+</b>      (string/array) - Include software passwords for username matching this username
     #
     # You may use the following properties to provide virtual server or software object filter instances:
     # * <b>+:virtual_server_object_filter+</b>    (ObjectFilter) - Include software passwords from software on virtual servers that matches the criteria of this object filter
@@ -493,19 +490,7 @@ module SoftLayer
         }
       }
 
-      if options_hash[:tags]
-        virtual_server_object_filter.set_criteria_for_key_path(option_to_filter_path[:virtual_server][:tags],
-                                                                {
-                                                                  'operation' => 'in',
-                                                                  'options' => [{
-                                                                                  'name' => 'data',
-                                                                                  'value' => options_hash[:tags].collect{ |tag_value| tag_value.to_s }
-                                                                                }]
-                                                                })
-      end
-
       option_to_filter_path[:virtual_server].each do |option, filter_path|
-        next if option == :tags
         virtual_server_object_filter.modify { |filter| filter.accept(filter_path).when_it is(options_hash[option]) } if options_hash[option]
       end
 

data/lib/softlayer/Ticket.rb

@@ -5,7 +5,7 @@
 #++
 
 module SoftLayer
-	class Ticket < SoftLayer::ModelBase
+  class Ticket < SoftLayer::ModelBase
 
     ##
     # :attr_reader:
@@ -17,9 +17,17 @@ module SoftLayer
     # The ticket system maintains a fixed set of subjects for tickets that are used to ensure tickets make it to the right folks quickly
     sl_attr :subject
 
+    ##
+    # :attr_reader: last_edited_at
+    # The date the ticket was last updated.
+    sl_attr :last_edited_at, 'lastEditDate'
+
     ##
     # :attr_reader:
     # The date the ticket was last updated.
+    #
+    # DEPRECATION WARNING: This attribute is deprecated in favor of last_edited_at
+    # and will be removed in the next major release.
     sl_attr :lastEditDate
 
     ##
@@ -35,12 +43,12 @@ module SoftLayer
       self['serverAdministrationFlag'] != 0
     end
 
-		##
-		# Add an update to this ticket.
-		#
-		def update(body = nil)
-			self.service.edit(self.softlayer_hash, body)
-		end
+    ##
+    # Add an update to this ticket.
+    #
+    def update(body = nil)
+      self.service.edit(self.softlayer_hash, body)
+    end
 
     ##
     # Override of service from ModelBase. Returns the SoftLayer_Ticket service
@@ -52,7 +60,7 @@ module SoftLayer
     ##
     # Override from model base. Requests new details about the ticket
     # from the server.
-		def softlayer_properties(object_mask = nil)
+    def softlayer_properties(object_mask = nil)
       my_service = self.service
 
       if(object_mask)
@@ -62,12 +70,12 @@ module SoftLayer
       end
 
       my_service.getObject()
-		end
+    end
 
     ##
     # Returns the default object mask,as a hash, that is used when
     # retrieving ticket information from the SoftLayer server.
-		def self.default_object_mask
+    def self.default_object_mask
       {
         "mask" => [
           'id',							# This is an internal ticket ID, not the one usually seen in the portal
@@ -84,23 +92,23 @@ module SoftLayer
           'serverAdministrationFlag',   # This comes in from the server as an integer :-(
         ]
       }.to_sl_object_mask
-		end
+    end
 
     ##
     # Queries the SoftLayer API to retrieve a list of the valid
     # ticket subjects.
-		def self.ticket_subjects(client = nil)
-			@ticket_subjects ||= nil
+    def self.ticket_subjects(client = nil)
+      @ticket_subjects ||= nil
 
-			if !@ticket_subjects
+      if !@ticket_subjects
         softlayer_client = client || Client.default_client
         raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 
-				@ticket_subjects = softlayer_client[:Ticket_Subject].getAllObjects();
-			end
+        @ticket_subjects = softlayer_client[:Ticket_Subject].getAllObjects();
+      end
 
-			@ticket_subjects
-		end
+      @ticket_subjects
+    end
 
     ##
     # Find the ticket with the given ID and return it
@@ -112,19 +120,20 @@ module SoftLayer
     # If a client is not provided then the routine will search Client::default_client
     # If Client::default_client is also nil the routine will raise an error.
     #
-		def self.ticket_with_id(ticket_id, options = {})
+    # Additionally you may provide options related to the request itself:
+    # * <b>*:object_mask*</b> (string) - The object mask of properties you wish to receive for the items returned.
+    #                                    If not provided, the result will use the default object mask
+    def self.ticket_with_id(ticket_id, options = {})
       softlayer_client = options[:client] || Client.default_client
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 
-      if options.has_key?(:object_mask)
-        object_mask = options[:object_mask]
-      else
-        object_mask = default_object_mask.to_sl_object_mask
-      end
+      ticket_service = softlayer_client[:Ticket].object_with_id(ticket_id)
+      ticket_service = ticket_service.object_mask(default_object_mask.to_sl_object_mask)
+      ticket_service = ticket_service.object_mask(options[:object_mask]) if options[:object_mask]
 
-      ticket_data = softlayer_client[:Ticket].object_with_id(ticket_id).object_mask(object_mask).getObject()
+      ticket_data    = ticket_service.getObject()
 
-      return new(softlayer_client, ticket_data)
+      return Ticket.new(softlayer_client, ticket_data)
     end
 
     ##
@@ -167,5 +176,5 @@ module SoftLayer
       ticket_data = softlayer_client[:Ticket].createStandardTicket(new_ticket, body)
       return new(softlayer_client, ticket_data)
     end
-	end
-end
+  end
+end

data/lib/softlayer/UserCustomer.rb

@@ -16,17 +16,24 @@ module SoftLayer
     include ::SoftLayer::DynamicAttribute
 
     ##
-    # :attr_reader:
+    # :attr_reader: alternate_phone
     # A portal user's secondary phone number.
     sl_attr :alternate_phone,  'alternatePhone'
 
     ##
-    # :attr_reader:
+    # :attr_reader: created_at
     # The date a portal user's record was created.
+    sl_attr :created_at,          'createDate'
+
+    ##
+    # :attr_reader: created
+    # The date a portal user's record was created.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of created_at
+    # and will be removed in the next major release.
     sl_attr :created,          'createDate'
 
     ##
-    # :attr_reader:
+    # :attr_reader: display_name
     # The portal user's display name.
     sl_attr :display_name,     'displayName'
 
@@ -36,32 +43,39 @@ module SoftLayer
     sl_attr :email
 
     ##
-    # :attr_reader:
+    # :attr_reader: first_name
     # A portal user's first name.
     sl_attr :first_name,       'firstName'
 
     ##
-    # :attr_reader:
+    # :attr_reader: last_name
     # A portal user's last name.
     sl_attr :last_name,        'lastName'
 
     ##
-    # :attr_reader:
+    # :attr_reader: modified_at
+    # The date a portal user's record was last modified.
+    sl_attr :modified_at,         'modifyDate'
+
+    ##
+    # :attr_reader: modified
     # The date a portal user's record was last modified.
+    # DEPRECATION WARNING: This attribute is deprecated in favor of modified_at
+    # and will be removed in the next major release.
     sl_attr :modified,         'modifyDate'
 
     ##
-    # :attr_reader:
+    # :attr_reader: office_phone
     # A portal user's office phone number.
     sl_attr :office_phone,     'officePhone'
 
     ##
-    # :attr_reader:
+    # :attr_reader: password_expires
     # The expiration date for the user's password.
     sl_attr :password_expires, 'passwordExpireDate'
 
     ##
-    # :attr_reader:
+    # :attr_reader: status_changed
     # The date a portal users record's last status change.
     sl_attr :status_changed,   'statusDate'
 
@@ -71,8 +85,10 @@ module SoftLayer
     sl_attr :username
 
     ##
-    # A portal user's additional email addresses.
+    # Retrieve a portal user's additional email addresses.
     # These email addresses are contacted when updates are made to support tickets.
+    # :call-seq:
+    #   additional_emails(force_update=false)
     sl_dynamic_attr :additional_emails do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -86,8 +102,10 @@ module SoftLayer
     end
 
     ##
-    # A portal user's API Authentication keys.
+    # Retrieve a portal user's API Authentication keys.
     # There is a max limit of two API keys per user.
+    # :call-seq:
+    #   api_authentication_keys(force_update=false)
     sl_dynamic_attr :api_authentication_keys do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -100,7 +118,9 @@ module SoftLayer
     end
     
     ##
-    # The external authentication bindings that link an external identifier to a SoftLayer user.
+    # Retrieve the external authentication bindings that link an external identifier to a SoftLayer user.
+    # :call-seq:
+    #   external_bindings(force_update=false)
     sl_dynamic_attr :external_bindings do |resource|
       resource.should_update? do
         #only retrieved once per instance
@@ -109,7 +129,30 @@ module SoftLayer
 
       resource.to_update do
         external_bindings = self.service.object_mask(UserCustomerExternalBinding.default_object_mask).getExternalBindings
-        external_bindings.collect { |external_binding| UserCustomerExternalBinding.new(soflayer_client, external_binding) }
+        external_bindings.collect { |external_binding| UserCustomerExternalBinding.new(softlayer_client, external_binding) }
+      end
+    end
+
+    ##
+    # Retrieve the user customer associated with the specified username
+    #
+    def self.user_customer_with_username(username, client = nil)
+      softlayer_client = client || Client.default_client
+      raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
+      raise "#{__method__} requires a user customer username but none was given" if !username || username.empty?
+
+      user_customer_object_filter = ObjectFilter.new()
+
+      user_customer_object_filter.modify { |filter| filter.accept('users.username').when_it is(username) }
+
+      account_service = Account.account_for_client(softlayer_client).service
+      account_service = account_service.object_filter(user_customer_object_filter)
+      account_service = account_service.object_mask(UserCustomer.default_object_mask)
+
+      user_customer_data = account_service.getUsers
+
+      if user_customer_data.length == 1
+        UserCustomer.new(softlayer_client, user_customer_data.first)
       end
     end