helpscout 0.0.4 → 0.0.5

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/helpscout.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "helpscout"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["H\u{e9}ctor Ramos"]
-  s.date = "2013-02-11"
+  s.date = "2013-02-12"
   s.description = ""
   s.email = "hector@hectorramos.com"
   s.extra_rdoc_files = [
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/hramos/helpscout"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.24"
   s.summary = "HelpScout API Wrapper"
 
   if s.respond_to? :specification_version then

data/lib/helpscout/client.rb

@@ -13,7 +13,7 @@
 # Rate Limiting
 # Requests will be limited to 200 requests per minute. Response code 429 will 
 # be returned when throttle limit has been reached. A "Retry-After" header will
-# be returned indicating how many seconds to wait until retry.
+#  be returned indicating how many seconds to wait until retry.
 #
 # Formats
 # Each endpoint will specify the response format in the URL. However, the API
@@ -82,13 +82,15 @@ module HelpScout
     #  Header   Status  Int    200
     #  Body     item
 
-    def self.requestItem(auth, url, params={})
+    def self.request_item(auth, url, params = {})
       item = nil
 
       request_url = ""
       request_url << url
       if params
-        request_url << "?" + params.to_query
+        query = ""
+        params.each { |k,v| query += "#{k}=#{v}&" }
+        request_url << "?" + query
       end
 
       begin
@@ -136,7 +138,7 @@ module HelpScout
     #           count   Int    Total number of objects available
     #           items   Array  Collection of objects
 
-    def self.requestItems(auth, url, params={})
+    def self.request_items(auth, url, params = {})
       items = []
 
       request_url = ""
@@ -192,7 +194,7 @@ module HelpScout
     #           count   Int    Total number of objects available
     #           items   Array  Collection of objects
 
-    def self.requestCount(auth, url, params={})
+    def self.request_count(auth, url, params = {})
       request_url = ""
       request_url << url
       if params
@@ -222,6 +224,36 @@ module HelpScout
       end     
     end
 
+
+    # Sends a POST request to create a single item from the Help Scout API.
+    #
+    # url     String  A string representing the url to POST.
+    # params  Hash    A hash of POST parameters to use for this particular 
+    #                 request.
+    #
+    # Response
+    #  Name      Type    Notes
+    #  Location  String  https://api.helpscout.net/v1/conversations/{id}.json
+
+    def self.create_item(auth, url, params = {})
+      begin
+        response = Client.post(url, {:basic_auth => auth, :headers => { 'Content-Type' => 'application/json' }, :body => params })
+      rescue SocketError => se
+        raise StandardError, se.message
+      end
+
+      if response.code == 201
+        if response["item"]
+          response["item"]
+        else
+          response["Location"]
+        end
+      else
+        raise StandardError.new("Server Response: #{response.code} #{response.message}")
+      end
+    end
+
+
     # HelpScout::Client.new
     # 
     # Initializes the Help Scout Client. Once called, you may use any of the 
@@ -230,7 +262,7 @@ module HelpScout
     # key  String  Help Scout API Key. Optional. If not passed, the key will be
     #              loaded from @@settings, which defaults to helpscout.yml.
 
-    def initialize(key = nil)
+    def initialize(key=nil)
       Client.settings
   
       if key.nil?
@@ -252,7 +284,11 @@ module HelpScout
     #
     # Request 
     #  REST Method: GET
-    #  URL: https://api.helpscout.net/v1/users/{id}.json
+    #  URL: https://api.helpscout.net/v1/conversations/{conversationId}.json
+    #
+    #  GET Parameters
+    #  Name            Type
+    #  conversationId  Int  id of the Conversation being requested
     #
     # Response
     #  Name  Type
@@ -260,7 +296,7 @@ module HelpScout
 
     def user(userId)
       url = "/users/#{userId}.json"
-      item = Client.requestItem(@auth, url, nil)
+      item = Client.request_item(@auth, url, nil)
       user = nil
       if item
         user = User.new(item)
@@ -288,7 +324,7 @@ module HelpScout
 
     def users
       url = "/users.json"
-      items = Client.requestItems(@auth, url, :page => 1)
+      items = Client.request_items(@auth, url, :page => 1)
       users = []
       items.each do |item|
         users << User.new(item)
@@ -316,9 +352,9 @@ module HelpScout
     #  Name   Type
     #  items  Array  Collection of User objects
 
-    def usersInMailbox(mailboxId)
+    def users_in_mailbox(mailboxId)
       url ="/mailboxes/#{mailboxId}/users.json"
-      items = Client.requestItems(@auth, url, :page => 1)
+      items = Client.request_items(@auth, url, :page => 1)
       users = []
       items.each do |item|
         users << User.new(item)
@@ -348,12 +384,12 @@ module HelpScout
       url = "/mailboxes.json"
       mailboxes = []
       begin
-        items = Client.requestItems(@auth, url, {})
+        items = Client.request_items(@auth, url, {})
         items.each do |item|
           mailboxes << Mailbox.new(item)
         end
       rescue StandardError => e
-        print "List Mailbox Request failed: " + e.message
+        puts "List Mailbox Request failed: #{e.message}"
       end
       mailboxes
     end
@@ -376,7 +412,7 @@ module HelpScout
     
     def mailbox(mailboxId)
       url = "/mailboxes/#{mailboxId}.json"
-      item = Client.requestItem(@auth, url, nil)
+      item = Client.request_item(@auth, url, nil)
       mailbox = nil
       if item
         mailbox = Mailbox.new(item)
@@ -404,9 +440,9 @@ module HelpScout
     #  Name   Type
     #  items  Array  Collection of Mailbox objects
 
-    def foldersInMailbox(mailboxId)
+    def folders_in_mailbox(mailboxId)
       url = "/mailboxes/#{mailboxId}/folders.json"
-      items = Client.requestItems(@auth, url, :page => 1)
+      items = Client.request_items(@auth, url, :page => 1)
       folders = []
       items.each do |item|
         folders << Folder.new(item)
@@ -416,7 +452,7 @@ module HelpScout
 
 
     # Get Conversation
-    # http://developer.helpscout.net/conversations/
+    # http://developer.helpscout.net/conversations/get/
     #
     # Fetches a single Conversation
     #
@@ -434,19 +470,58 @@ module HelpScout
       url = "/conversations/#{conversationId}.json"
 
       begin
-        item = Client.requestItem(@auth, url, nil)
+        item = Client.request_item(@auth, url, nil)
         conversation = nil
         if item
           conversation = Conversation.new(item)
         end
       rescue StandardError => e
-        print "Could not fetch conversation with id #{conversationId}: " + e.message
+        puts "Could not fetch conversation with id #{conversationId}: #{e.message}"
+      end
+    end
+
+
+    # Create Conversation
+    # http://developer.helpscout.net/conversations/create/
+    #
+    # Creates a new Conversation.
+    #
+    # Request
+    #  REST Method: POST
+    #  URL: https://api.helpscout.net/v1/conversations.json
+    #
+    #  POST Parameters
+    #  Name          Type          Required  Notes
+    #  conversation  Conversation  Yes       
+    #  import        boolean       No        The import parameter enables 
+    #                                        conversations to be created for 
+    #                                        historical purposes (i.e. if moving
+    #                                        from a different platform, you can 
+    #                                        import your history). When import 
+    #                                        is set to true, no outgoing emails 
+    #                                        or notifications will be generated.
+    #  reload        boolean       No        Set this parameter to 'true' to 
+    #                                        return the created conversation in 
+    #                                        the response.
+    #
+
+    def create_conversation(conversation)
+      if !conversation
+        raise StandardError.new("Missing Conversation")
+      end
+
+      url = "/conversations.json"
+
+      begin
+        response = Client.create_item(@auth, url, conversation.to_json)
+      rescue StandardError => e
+        puts "Could not create conversation: #{e.message}"
       end
     end
 
 
     # List Conversations
-    # http://developer.helpscout.net/conversations/
+    # http://developer.helpscout.net/conversations/list/
     #
     # Fetches conversations in a mailbox with a given status
     #
@@ -513,13 +588,13 @@ module HelpScout
 
       begin
         options["page"] = page
-        items = Client.requestItems(@auth, url, options)
+        items = Client.request_items(@auth, url, options)
         items.each do |item|
           conversations << Conversation.new(item)
         end
         page = page + 1
       rescue StandardError => e
-        print "List Conversations Request failed: " + e.message
+        puts "List Conversations Request failed: #{e.message}"
       end while items && items.count > 0 && (limit == 0 || conversations.count < limit)
 
       if limit > 0 && conversations.count > limit
@@ -573,7 +648,7 @@ module HelpScout
     #                threads, you need to retrieve the full conversation object 
     #                via the Get Conversation call.
 
-    def conversationsInFolder(mailboxId, folderId, status, limit=0, modifiedSince)
+    def conversations_in_folder(mailboxId, folderId, status, limit=0, modifiedSince)
       url = "/mailboxes/#{mailboxId}/folders/#{folderId}/conversations.json"
 
       page = 1
@@ -595,13 +670,13 @@ module HelpScout
 
       begin
         options["page"] = page
-        items = Client.requestItems(@auth, url, options)
+        items = Client.request_items(@auth, url, options)
         items.each do |item|
           conversations << Conversation.new(item)
         end
         page = page + 1
       rescue StandardError => e
-        print "List Conversations In Folder Request failed: " + e.message
+        puts "List Conversations In Folder Request failed: #{e.message}"
       end while items && items.count > 0 && (limit == 0 || conversations.count < limit)
 
       if limit > 0 && conversations.count > limit
@@ -647,7 +722,7 @@ module HelpScout
     #  Name   Type
     #  count  Integer  Count of Conversation objects.
 
-    def conversationCount(mailboxId, status, modifiedSince)
+    def conversation_count(mailboxId, status, modifiedSince)
       url = "/mailboxes/#{mailboxId}/conversations.json"
 
       page = 1
@@ -665,9 +740,9 @@ module HelpScout
 
       begin
         options["page"] = page
-        count = Client.requestCount(@auth, url, options)
+        count = Client.request_count(@auth, url, options)
       rescue StandardError => e
-        print "Conversation Count Request failed: " + e.message
+        puts "Conversation Count Request failed: #{e.message}"
       end
     end
 
@@ -687,9 +762,9 @@ module HelpScout
     #  Name  Type
     #  item  Conversation::AttachmentData
 
-    def attachmentData(attachmentId)
+    def attachment_data(attachmentId)
       url = "/attachments/#{attachmentId}/data.json"
-      item = Client.requestItem(@auth, url, nil)
+      item = Client.request_item(@auth, url, nil)
       attachmentData = nil
       if item
         attachmentData = Conversation::AttachmentData.new(item)
@@ -716,7 +791,7 @@ module HelpScout
 
     def customer(customerId)
       url = "/customers/#{customerId}.json"
-      item = Client.requestItem(@auth, url, nil)
+      item = Client.request_item(@auth, url, nil)
       customer = nil
       if item
         customer = Customer.new(item)
@@ -729,8 +804,10 @@ module HelpScout
     # List Customers
     # http://developer.helpscout.net/customers/
     #
-    # Fetches all customers. Customers are returned by createdAt date, from 
-    # newest to oldest.
+    # Customers can be filtered on any combination of first name, last name, and
+    # email.
+    #
+    # Customers are returned by createdAt date, from newest to oldest.    
     #
     # Request 
     #  REST Method: GET
@@ -738,21 +815,97 @@ module HelpScout
     #
     #  Parameters:
     #   Name           Type      Required  Default  Notes
-    #   page           Int       No        1 
+    #   Name       Type    Required  Default
+    #   firstName  String  No
+    #   lastName   String  No
+    #   email      String  No
+    #   page       Int     No        1
     #
     # Response
     #  Name   Type
     #  items  Array  Collection of Customer objects.
 
-    def customers
+    def customers(limit=0, firstName=nil, lastName=nil, email=nil)
       url = "/customers.json"
-      items = Client.requestItems(@auth, url, :page => 1)
+
+      page = 1
+      options = {}
+
+      if limit < 0
+        limit = 0
+      end
+
+      if firstName
+        options["firstName"] = firstName
+      end
+
+      if lastName
+        options["lastName"] = lastName
+      end
+
+      if email
+        options["email"] = email
+      end
+
       customers = []
-      items.each do |item|
-        customers << Customer.new(item)
+
+      begin
+        options["page"] = page
+        items = Client.request_items(@auth, url, options)
+        items.each do |item|
+          customers << Customer.new(item)
+        end
+        page = page + 1
+      rescue StandardError => e
+        puts "Request failed: #{e.message}"
+      end while items && items.count > 0 && (limit == 0 || customers.count < limit)
+
+      if limit > 0 && customers.count > limit
+        customers = customers[0..limit-1]
       end
 
       customers
     end
+
+    # Helper method to find customers by email
+    def customers_by_email(email)
+      customers(0, nil, nil, email)
+    end
+
+    # Create Customer
+    # http://developer.helpscout.net/customers/create/
+    #
+    # Creates a new Customer.
+    #
+    # Request
+    #  REST Method: POST
+    #  URL: https://api.helpscout.net/v1/customers.json
+    #
+    #  POST Parameters
+    #  Name      Type      Required  Notes
+    #  customer  Customer  Yes       The body of the request       
+    #  reload    boolean   No        Set to true to return the customer in the 
+    #                                response.
+    # Response
+    #  Response   Name      Type    Notes
+    #  Header     Status    Integer 201
+    #  Header     Location  String  https://api.helpscout.net/v1/customer/{id}.json
+
+    def create_customer(customer)
+      if !customer
+        raise StandardError.new("Missing Customer")
+      end
+
+      url = "/customers.json"
+      params = JSON.parse(customer.to_json)
+
+      begin
+        response = Client.create_item(@auth, url, customer.to_json)
+        true
+      rescue StandardError => e
+        puts "Could not create customer: #{e.message}"
+        false
+      end
+    end
   end  
 end

data/lib/helpscout/models.rb

@@ -68,14 +68,14 @@ module HelpScout
   # *name       String    Feedback              Name of the Mailbox
   #  slug       String    47204a026903ce6d      Key used to represent this 
   #                                             Mailbox
-  #  email      String    feedback@support.com  Email address
+  #  email      String    feedback@parse.com    Email address
   #  createdAt  DateTime  2012-07-23T12:34:12Z  UTC time when this mailbox was 
   #                                             created.
   #  modifiedAt DateTime  2012-07-24T20:18:33Z  UTC time when this mailbox was 
   #                                             modified.
 
   class Mailbox
-    attr_reader :id, :name, :slug, :email, :createdAt, :modifiedAt
+    attr_reader :id, :name, :slug, :email, :createdAt, :modifiedAt, :folders
 
     # Creates a new Mailbox object from a Hash of attributes
     def initialize(object)
@@ -87,6 +87,13 @@ module HelpScout
       
       @slug = object["slug"]
       @email = object["email"]
+
+      @folders = []
+      if object["folders"]
+        object["folders"].each do |folder|
+          @folders << Folder.new(folder)
+        end
+      end      
     end
   end
 
@@ -101,12 +108,12 @@ module HelpScout
   #  isDraft      Boolean     false                 Is this a draft?
   #  number       Int         349                   The conversation number 
   #                                                 displayed in the UI.
-  #  owner        User                              User of the Help Scout user 
+  #  owner        Person                            User of the Help Scout user 
   #                                                 that is currently assigned 
   #                                                 to this conversation
   #  mailbox      Mailbox                           Mailbox to which this 
   #                                                 conversation belongs.
-  #  customer     Customer                          Customer to which this 
+  #  customer     Person                            Customer to which this 
   #                                                 conversation belongs.
   #  threadCount  Int         4                     This count represents the 
   #                                                 number of published threads 
@@ -118,9 +125,9 @@ module HelpScout
   #  status       String      active                Status of the conversation.
   #  subject      String      I need help!   
   #  preview      String      Hello, I...   
-  #  createdBy    Customer                          Either the Customer or User 
-  #               - or -                            that created this 
-  #               User                              conversation. 
+  #  createdBy    Person                            Either the Customer or User 
+  #                                                 that created this 
+  #                                                 conversation. 
   #                                                 Inspect the Source object 
   #                                                 for clarification.
   #  createdAt    DateTime    2012-07-23T12:34:12Z  UTC time when this 
@@ -130,7 +137,7 @@ module HelpScout
   #  closedAt     DateTime                          UTC time when this 
   #                                                 conversation was closed.
   #                                                 Null if not closed.
-  #  closedBy     User                              User of the Help Scout user 
+  #  closedBy     Person                            User of the Help Scout user 
   #                                                 that closed this 
   #                                                 conversation.
   #  source       Source                            Specifies the method in 
@@ -153,7 +160,7 @@ module HelpScout
   # * STATUS_SPAM
 
   class Conversation
-    attr_reader :id, :folderId, :isDraft, :number, :owner, :mailbox, :customer, :threadCount, :status, :subject, :preview, :createdBy, :createdAt, :modifiedAt, :closedAt, :closedBy, :source, :cc, :bcc, :tags, :threads, :url
+    attr_reader :id, :type, :folderId, :isDraft, :number, :owner, :mailbox, :customer, :threadCount, :status, :subject, :preview, :createdBy, :createdAt, :modifiedAt, :closedAt, :closedBy, :source, :cc, :bcc, :tags, :threads, :url
 
     STATUS_ACTIVE = "active"
     STATUS_PENDING = "pending"
@@ -165,32 +172,22 @@ module HelpScout
       @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
       @modifiedAt = DateTime.iso8601(object["userModifiedAt"]) if object["userModifiedAt"]
       @closedAt = DateTime.iso8601(object["closedAt"]) if object["closedAt"]
+
       @id = object["id"]
+      @type = object["type"]
       @folderId = object["folderId"]
       @isDraft = object["isDraft"]
       @number = object["number"]
-      @owner = User.new(object["owner"]) if object["owner"]
+      @owner = Person.new(object["owner"]) if object["owner"]
       @mailbox = Mailbox.new(object["mailbox"]) if object["mailbox"]
-      @customer = Customer.new(object["customer"]) if object["customer"]
+      @customer = Person.new(object["customer"]) if object["customer"]
       @threadCount = object["threadCount"]
       @status = object["status"]
       @subject = object["subject"]
       @preview = object["preview"]
-      @closedBy = User.new(object["closedBy"]) if object["closedBy"]
-
-      @source = nil
-      if object["source"]
-        @source = Source.new(object["source"])
-
-        if object["createdBy"]
-          if @source.type == Source::VIA_CUSTOMER
-            @createdBy = Customer.new(object["createdBy"])
-          elsif @source.type == Source::VIA_USER
-            @createdBy = User.new(object["createdBy"])
-          end
-        end
-      end
-
+      @closedBy = Person.new(object["closedBy"]) if object["closedBy"]
+      @createdBy = Person.new(object["person"]) if object["person"]
+      @source = Source.new(object["source"]) if object["source"]
       @cc = object["cc"]
       @bcc = object["bcc"]
       @tags = object["tags"]
@@ -216,7 +213,7 @@ module HelpScout
     #
     #  Name         Type      Example               Notes
     #  id           Int       88171881              Unique identifier
-    #  assignedTo   User                            User of the Help Scout user 
+    #  assignedTo   Person                          User of the Help Scout user 
     #                                               to which this conversation 
     #                                               has been assigned.
     #  status       String    active                Status of the thread. Thread
@@ -226,9 +223,9 @@ module HelpScout
     #                                               be set to STATUS_NO_CHANGE.
     #  createdAt    DateTime  2012-07-23T12:34:12Z  UTC time when this thread 
     #                                               was created.
-    #  createdBy    Customer                        Either the Customer or User 
-    #               - or -                          that created this 
-    #               User                            conversation. Inspect the 
+    #  createdBy    Person                          Either the Customer or User 
+    #                                               that created this 
+    #                                               conversation. Inspect the 
     #                                               Source object for 
     #                                               clarification.
     #  source       Source     
@@ -238,7 +235,7 @@ module HelpScout
     #                                               which it was moved.
     #  type         String    message               The type of thread. 
     #  state        String    published             The state of the thread. 
-    #  customer     Customer                        If type is message, this is 
+    #  customer     Person                          If type is message, this is 
     #                                               the Customer of the customer
     #                                               in which the message was 
     #                                               sent. If type is customer, 
@@ -319,26 +316,14 @@ module HelpScout
         @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
 
         @id = object["id"]
-        @assignedTo = User.new(object["assignedTo"]) if object["assignedTo"]
+        @assignedTo = Person.new(object["assignedTo"]) if object["assignedTo"]
+        @createdBy = Person.new(object["createdBy"]) if object["createdBy"]
         @status = object["status"]
-
-        @source = nil
-        if object["source"]
-          @source = Source.new(object["source"])
-
-          if object["createdBy"]
-            if @source.type == Source::VIA_CUSTOMER
-              @createdBy = Customer.new(object["createdBy"])
-            elsif @source.type == Source::VIA_USER
-              @createdBy = User.new(object["createdBy"])
-            end
-          end
-        end
-
+        @source = Source.new(object["source"]) if object["source"]
         @fromMailbox = Mailbox.new(object["fromMailbox"]) if object["fromMailbox"]
         @type = object["type"]
         @state = object["state"]
-        @customer = Customer.new(object["customer"]) if object["customer"]
+        @customer = Person.new(object["customer"]) if object["customer"]
         @body = object["body"]
         @to = object["to"]
         @cc = object["cc"]
@@ -408,21 +393,56 @@ module HelpScout
   end
 
 
-  # User
-  # http://developer.helpscout.net/objects/user/
-  # http://developer.helpscout.net/objects/user/user-ref/
+  # Person
+  # http://developer.helpscout.net/objects/person/
   #
-  # UserRefs are a subset of a full User object, and only include the attributes
-  # marked with a *.
+  # The person object is a subset of the data representing a Customer or 
+  # User. The 'type' property will specify if this person is represented by 
+  # a 'user' or a 'customer'.
   # 
-  # UserRefs are returned by endpoints that include multiple users.
-  # A full User object can be obtained by fetching a single user directly.
+  #  Name        Type      Example                 Notes
+  #  id          Int       1234                    Unique identifier
+  #  firstName   String    Jack   
+  #  lastName    String    Sprout   
+  #  email       String    jack.sprout@gmail.com  
+  #  phone       String    800-555-1212  
+  #  type        String    user 
+  #
+  # Possible values for type include:
+  # * TYPE_USER
+  # * TYPE_CUSTOMER
+
+  class Person
+    attr_reader :id, :firstName, :lastName, :email, :phone, :type
+
+    TYPE_USER = "user"
+    TYPE_CUSTOMER = "customer"
+
+    # Creates a new Person object from a Hash of attributes
+    def initialize(object)
+      @id = object["id"]
+      @firstName = object["firstName"]
+      @lastName = object["lastName"]
+      @email = object["email"]
+      @phone = object["phone"]
+      @type = object["type"]
+    end
+
+    # Returns a String suitable for display
+    def to_s
+      "#{@firstName} #{@lastName}"
+    end
+  end
+
+
+  # User
+  # http://developer.helpscout.net/objects/user/
   #
   #  Name        Type      Example                 Notes
-  # *id          Int       1234                    Unique identifier
-  # *firstName   String    Jack   
-  # *lastName    String    Sprout   
-  # *email       String    jack.sprout@gmail.com  
+  #  id          Int       1234                    Unique identifier
+  #  firstName   String    Jack   
+  #  lastName    String    Sprout   
+  #  email       String    jack.sprout@gmail.com  
   #  role        String    owner                   Role of this user.
   #  timezone    String    America/New_York   
   #  photoUrl    String    http://.../avatar.jpg   The user's photo, if one 
@@ -438,7 +458,7 @@ module HelpScout
   # * ROLE_USER
 
   class User
-    attr_reader :id, :firstName, :lastName, :email, :role, :timezone, :photoUrl, :createdAt, :createdBy
+    attr_reader :id, :firstName, :lastName, :email, :role, :timezone, :photoUrl, :createdAt, :modifiedAt
 
     ROLE_OWNER = "owner"
     ROLE_ADMIN = "admin"
@@ -447,6 +467,7 @@ module HelpScout
     # Creates a new User object from a Hash of attributes
     def initialize(object)
       @createdAt = DateTime.iso8601(object["createdAt"]) if object["createdAt"]
+      @modifiedAt = DateTime.iso8601(object["modifiedAt"]) if object["modifiedAt"]
 
       @id = object["id"]
       @firstName = object["firstName"]
@@ -455,7 +476,6 @@ module HelpScout
       @role = object["role"]
       @timezone = object["timezone"]
       @photoUrl = object["photoUrl"]
-      @createdBy = object["createdBy"]
     end
 
     # Returns a String suitable for display
@@ -464,18 +484,11 @@ module HelpScout
     end
   end
 
-
   # Customer
   # http://developer.helpscout.net/objects/customer/
-  # http://developer.helpscout.net/objects/customer/customer-ref/
-  #
-  # CustomerRefs are a subset of a full Customer object, and only include the 
-  # attributes marked with a *.
-  #
-  # CustomerRefs are returned by endpoints that include multiple customers.
   #
-  # A full Customer object can be obtained by fetching a single customer 
-  # directly.
+  # Attributes marked with a * are returned when listing customers. Other
+  # attributes are only returned when fetching a single customer.
   #
   #  Name          Type      Example               Notes
   # *id            Int       29418                 Unique identifier
@@ -483,17 +496,25 @@ module HelpScout
   # *lastName      String    Bear   
   # *email         String    vbear@mywork.com      If the customer has multiple 
   #                                                emails, only one is returned.
-  #  photoUrl      String    http://../avatar.jpg   
-  #  photoType     String    twitter               Type of photo.
-  #  gender        String    Male                  Gender of this customer.
-  #  age           String    30-35  
-  #  organization  String    Acme, Inc  
-  #  jobTitle      String    CEO and Co-Founder   
-  #  location      String    Austin
-  #  createdAt     DateTime  2012-07-23T12:34:12Z  UTC time when this customer 
+  # *photoUrl      String    http://../avatar.jpg   
+  # *photoType     String    twitter               Type of photo.
+  # *gender        String    Male                  Gender of this customer.
+  # *age           String    30-35  
+  # *organization  String    Acme, Inc  
+  # *jobTitle      String    CEO and Co-Founder   
+  # *location      String    Austin
+  # *createdAt     DateTime  2012-07-23T12:34:12Z  UTC time when this customer 
   #                                                was created.
-  #  modifiedAt    DateTime  2012-07-24T20:18:33Z  UTC time when this customer 
+  # *modifiedAt    DateTime  2012-07-24T20:18:33Z  UTC time when this customer 
   #                                                was modified.
+  #  background      String   I've worked with...  This is the Background Info 
+  #                                                field from the UI.
+  #  address         Address
+  #  socialProfiles  Array                         Array of SocialProfiles    
+  #  emails          Array                         Array of Emails
+  #  phones          Array                         Array of Phones
+  #  chats           Array                         Array of Chats
+  #  websites        Array                         Array of Websites
   #
   # Possible values for photoType include:
   # * PHOTO_TYPE_UNKNOWN

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helpscout
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000Z
+date: 2013-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70109893584620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70109893584620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70109893583940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 1.2.3
   type: :development
   prerelease: false
-  version_requirements: *70109893583940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70109893583180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *70109893583180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70109893582640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109893582640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70109893582100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109893582100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: reek
-  requirement: &70109893581420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: 1.2.8
   type: :development
   prerelease: false
-  version_requirements: *70109893581420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70109893580760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +117,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70109893580760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email: hector@hectorramos.com
 executables: []
@@ -118,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -795765520829784459
+      hash: 3673943477065505692
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: HelpScout API Wrapper