class HelpScout::Folder

Folder developer.helpscout.net/objects/folder/

Name         Type      Example               Notes
id           Int       1234                  Unique identifier
name         String    My Tickets            Folder name
type         String    mytickets             The type this folder 
                                             represents.
userId       Int       4532                  If the folder type is 
                                             TYPE_MY_TICKETS, userId 
                                             represents the Help Scout user
                                             to which this folder belongs. 
                                             Otherwise userId is 0.
totalCount   Int       2                     Total number of conversations 
                                             in this folder
activeCount  Int       1                     Total number of conversations 
                                             in this folder that are in an 
                                             active state (vs pending).
modifiedAt   DateTime  2012-07-24T20:18:33Z  UTC time when this folder was 
                                             modified.

Possible values for type include:

Constants

TYPE_ASSIGNED
TYPE_CLOSED
TYPE_DRAFTS
TYPE_MY_TICKETS
TYPE_SPAM
TYPE_UNASSIGNED

Attributes

activeCount[R]
id[R]
modifiedAt[R]
name[R]
totalCount[R]
type[R]
userId[R]

Public Class Methods

new(object) click to toggle source

Creates a new Folder object from a Hash of attributes

# File lib/helpscout/models.rb, line 897
def initialize(object)
  @modifiedAt = DateTime.iso8601(object["modifiedAt"]) if object["modifiedAt"]

  @id = object["id"]
  @name = object["name"]
  @type = object["type"]
  @userId = object["userId"]
  @totalCount = object["totalCount"]
  @activeCount = object["activeCount"]
end