cleanup/doc work from installer scheduling, RT#16584

[freeside.git] / FS / FS / agent.pm

diff --git a/FS/FS/agent.pm b/FS/FS/agent.pm
index 0fdc5f5..fbfba9b 100644 (file)
--- a/FS/FS/agent.pm
+++ b/FS/FS/agent.pm
@@ -44,27 +44,49 @@ from FS::Record.  The following fields are currently supported:
 
 =over 4
 
-=item agentnum - primary key (assigned automatically for new agents)
+=item agentnum
 
-=item agent - Text name of this agent
+primary key (assigned automatically for new agents)
 
-=item typenum - Agent type (see L<FS::agent_type>)
+=item agent
 
-=item ticketing_queueid - Ticketing Queue
+Text name of this agent
 
-=item invoice_template - Invoice template name
+=item typenum
 
-=item agent_custnum - Optional agent customer (see L<FS::cust_main>)
+Agent type (see L<FS::agent_type>)
 
-=item disabled - Disabled flag, empty or 'Y'
+=item ticketing_queueid
 
-=item prog - Deprecated (never used)
+Ticketing Queue
 
-=item freq - Deprecated (never used)
+=item invoice_template
 
-=item username - (Deprecated) Username for the Agent interface
+Invoice template name
 
-=item _password - (Deprecated) Password for the Agent interface
+=item agent_custnum
+
+Optional agent customer (see L<FS::cust_main>)
+
+=item disabled
+
+Disabled flag, empty or 'Y'
+
+=item prog
+
+Deprecated (never used)
+
+=item freq
+
+Deprecated (never used)
+
+=item username
+
+(Deprecated) Username for the Agent interface
+
+=item _password
+
+(Deprecated) Password for the Agent interface
 
 =back
 
@@ -125,6 +147,7 @@ sub check {
       || $self->ut_textn('prog')
       || $self->ut_textn('invoice_template')
       || $self->ut_foreign_keyn('agent_custnum', 'cust_main', 'custnum' )
+      || $self->ut_numbern('ticketing_queueid')
   ;
   return $error if $error;
 
@@ -209,7 +232,7 @@ field, or the empty string.
 sub ticketing_queue {
   my $self = shift;
   FS::TicketSystem->queue($self->ticketing_queueid);
-};
+}
 
 =item payment_gateway [ OPTION => VALUE, ... ]
 
@@ -430,14 +453,15 @@ sub num_ordered_cust_main {
   shift->num_sql(FS::cust_main->ordered_sql);
 }
 
-=item active_cust_main
+=item ordered_cust_main
 
-Returns the active customers for this agent, as cust_main objects.
+Returns the ordered customers for this agent (customers with packages ordered,
+but not yet billed), as cust_main objects.
 
 =cut
 
-sub active_cust_main {
-  shift->cust_main_sql(FS::cust_main->active_sql);
+sub ordered_cust_main {
+  shift->cust_main_sql(FS::cust_main->ordered_sql);
 }