Difference between revisions of "Freeside:1.9:Documentation:Developer/FS"

From Freeside
Jump to: navigation, search
 
Line 1: Line 1:
stub for autocreation
+
==NAME==
 +
FS - Freeside Perl modules
 +
 
 +
==SYNOPSIS==
 +
Freeside perl modules and CLI utilities.
 +
 
 +
===Utility classes===
 +
[[Freeside:1.9:Documentation:Developer/FS/Conf|FS::Conf]] - Freeside configuration values
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/ConfItem|FS::ConfItem]] - Freeside configuration option meta-data.
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/UID|FS::UID]] - User class (not yet OO)
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/CGI|FS::CGI]] - Non OO-subroutines for the web interface.
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/Msgcat|FS::Msgcat]] - Message catalog
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/SearchCache|FS::SearchCache]] - Search cache
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/raddb|FS::raddb]] - RADIUS dictionary
 +
 
 +
===Database record classes===
 +
[[Freeside:1.9:Documentation:Developer/FS/Record|FS::Record]] - Database record base class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc acct pop|FS::svc_acct_pop]] - POP (Point of Presence, not Post Office Protocol) class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part pop local|FS::part_pop_local]] - Local calling area class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part referral|FS::part_referral]] - Referral class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust main county|FS::cust_main_county]] - Locale (tax rate) class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust tax exempt|FS::cust_tax_exempt]] - Tax exemption record class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc Common|FS::svc_Common]] - Service base class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc acct|FS::svc_acct]] - Account (shell, RADIUS, POP3) class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/acct snarf|FS::acct_snarf]] - External mail account class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/radius usergroup|FS::radius_usergroup]] - RADIUS groups
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc domain|FS::svc_domain]] - Domain class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/domain record|FS::domain_record]] - DNS zone entries
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc forward|FS::svc_forward]] - Mail forwarding class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc www|FS::svc_www]] - Web virtual host class.
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc broadband|FS::svc_broadband]] - DSL, wireless and other broadband class.
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/svc external|FS::svc_external]] - Externally tracked service class.
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part svc|FS::part_svc]] - Service definition class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part svc column|FS::part_svc_column]] - Column constraint class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/export svc|FS::export_svc]] - Class linking service definitions (see [[Freeside:1.9:Documentation:Developer/FS/
 +
part svc|FS::part_svc]]) with exports (see [[Freeside:1.9:Documentation:Developer/FS/part export|FS::part_export]])
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part export|FS::part_export]] - External provisioning export class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part export option|FS::part_export_option]] - Export option class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part pkg|FS::part_pkg]] - Package definition class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part pkg option|FS::part_pkg_option]] - Package definition option class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/pkg svc|FS::pkg_svc]] - Class linking package definitions (see [[Freeside:1.9:Documentation:Developer/FS/part p
 +
kg|FS::part_pkg]]) with service definitions (see [[Freeside:1.9:Documentation:Developer/FS/part svc|FS::part_svc]])
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/reg code|FS::reg_code]] - One-time registration codes
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/reg code pkg|FS::reg_code_pkg]] - Class linking registration codes (see [[Freeside:1.9:Documentation:Developer/
 +
FS/reg code|FS::reg_code]]) with package definitions (see [[Freeside:1.9:Documentation:Developer/FS/part pkg|FS::part_pkg]])
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/rate|FS::rate]] - Rate plans for call billing
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/rate region|FS::rate_region]] - Rate regions for call billing
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/rate prefix|FS::rate_prefix]] - Rate region prefixes for call billing
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/rate detail|FS::rate_detail]] - Rate plan detail for call billing
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/agent|FS::agent]] - Agent (reseller) class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/agent type|FS::agent_type]] - Agent type class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/type pkgs|FS::type_pkgs]] - Class linking agent types (see [[Freeside:1.9:Documentation:Developer/FS/agent type
 +
|FS::agent_type]]) with package definitions (see [[Freeside:1.9:Documentation:Developer/FS/part pkg|FS::part_pkg]])
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust svc|FS::cust_svc]] - Service class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust pkg|FS::cust_pkg]] - Customer package class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust pkg option|FS::cust_pkg_option]] - Customer package option class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust main|FS::cust_main]] - Customer class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust main invoice|FS::cust_main_invoice]] - Invoice destination class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill|FS::cust_bill]] - Invoice class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill pkg|FS::cust_bill_pkg]] - Invoice line item class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill pkg detail|FS::cust_bill_pkg_detail]] - Invoice line item detail class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/part bill event|FS::part_bill_event]] - Invoice event definition class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill event|FS::cust_bill_event]] - Completed invoice event class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust pay|FS::cust_pay]] - Payment class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust pay void|FS::cust_pay_void]] - Voided payment class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust bill pay|FS::cust_bill_pay]] - Payment application class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust credit|FS::cust_credit]] - Credit class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust refund|FS::cust_refund]] - Refund class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust credit refund|FS::cust_credit_refund]] - Refund application to credit class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust credit bill|FS::cust_credit_bill]] - Credit application to invoice class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust pay refund|FS::cust_pay_refund]] - Refund application to payment class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/pay batch|FS::pay_batch]] - Credit card transaction queue class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/cust pay batch|FS::cust_pay_batch]] - Credit card transaction member queue class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/prepay credit|FS::prepay_credit]] - Prepaid "calling card" credit class.
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/nas|FS::nas]] - Network Access Server class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/port|FS::port]] - NAS port class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/session|FS::session]] - User login session class
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/queue|FS::queue]] - Job queue
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/queue arg|FS::queue_arg]] - Job arguments
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/queue depend|FS::queue_depend]] - Job dependencies
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/msgcat|FS::msgcat]] - Message catalogs
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/clientapi session|FS::clientapi_session]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/clientapi session field|FS::clientapi_session_field]]
 +
 
 +
==Client API==
 +
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI|FS::ClientAPI]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI SessionCache|FS::ClientAPI_SessionCache]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI/Signup|FS::ClientAPI::Signup]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI/passwd|FS::ClientAPI::passwd]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI/MyAccount|FS::ClientAPI::MyAccount]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/ClientAPI/Agent|FS::ClientAPI::Agent]]
 +
 
 +
==Remote API modules==
 +
[[Freeside:1.9:Documentation:Developer/FS/SelfService|FS::SelfService]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/SignupClient|FS::SignupClient]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/SessionClient|FS::SessionClient]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/FS/MailAdminServer|FS::MailAdminServer]] (deprecated in favor of the self-service server)
 +
 
 +
===Command-line utilities===
 +
[[Freeside:1.9:Documentation:Developer/freeside-adduser|freeside-adduser]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-queued|freeside-queued]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-daily|freeside-daily]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-expiration-alerter|freeside-expiration-alerter]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-email|freeside-email]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-cc-receipts-report|freeside-cc-receipts-report]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-credit-report|freeside-credit-report]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-receivables-report|freeside-receivables-report]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-tax-report|freeside-tax-report]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-bill|freeside-bill]]
 +
 
 +
[[Freeside:1.9:Documentation:Developer/freeside-overdue|freeside-overdue]]
 +
 
 +
===User Interface classes===
 +
[[Freeside:1.9:Documentation:Developer/FS/UI/Web|FS::UI::Web]] - Web user-interface class
 +
 
 +
===Notes===
 +
To quote perl(1), "If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references."
 +
 
 +
If you've never used OO modules before, http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
 +
 
 +
==DESCRIPTION==
 +
Freeside is a billing and administration package for Internet Service Providers.
 +
 
 +
The Freeside home page is at <http://www.sisd.com/freeside>.
 +
 
 +
The main documentation is in httemplate/docs.
 +
 
 +
==SUPPORT==
 +
A mailing list for users is available. Send a blank message to <freeside-users-subscribe@sisd.com> to subscribe.
 +
 
 +
A mailing list for developers is available. It is intended to be lower volume and higher SNR than the users list. Send a blank message to <freeside-devel-subscribe@sisd.com> to subscribe.
 +
 
 +
Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.
 +
 
 +
==AUTHOR==
 +
Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
 +
 
 +
See the CREDITS file in the Freeside distribution for a (hopefully) complete list and the individal files for details.
 +
 
 +
==SEE ALSO==
 +
perl(1), main Freeside documentation in htdocs/docs/
 +
 
 +
==BUGS==
 +
Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP...

Revision as of 15:31, 3 October 2007

NAME

FS - Freeside Perl modules

SYNOPSIS

Freeside perl modules and CLI utilities.

Utility classes

FS::Conf - Freeside configuration values

FS::ConfItem - Freeside configuration option meta-data.

FS::UID - User class (not yet OO)

FS::CGI - Non OO-subroutines for the web interface.

FS::Msgcat - Message catalog

FS::SearchCache - Search cache

FS::raddb - RADIUS dictionary

Database record classes

FS::Record - Database record base class

FS::svc_acct_pop - POP (Point of Presence, not Post Office Protocol) class

FS::part_pop_local - Local calling area class

FS::part_referral - Referral class

FS::cust_main_county - Locale (tax rate) class

FS::cust_tax_exempt - Tax exemption record class

FS::svc_Common - Service base class

FS::svc_acct - Account (shell, RADIUS, POP3) class

FS::acct_snarf - External mail account class

FS::radius_usergroup - RADIUS groups

FS::svc_domain - Domain class

FS::domain_record - DNS zone entries

FS::svc_forward - Mail forwarding class

FS::svc_www - Web virtual host class.

FS::svc_broadband - DSL, wireless and other broadband class.

FS::svc_external - Externally tracked service class.

FS::part_svc - Service definition class

FS::part_svc_column - Column constraint class

FS::export_svc - Class linking service definitions (see [[Freeside:1.9:Documentation:Developer/FS/ part svc|FS::part_svc]]) with exports (see FS::part_export)

FS::part_export - External provisioning export class

FS::part_export_option - Export option class

FS::part_pkg - Package definition class

FS::part_pkg_option - Package definition option class

FS::pkg_svc - Class linking package definitions (see [[Freeside:1.9:Documentation:Developer/FS/part p kg|FS::part_pkg]]) with service definitions (see FS::part_svc)

FS::reg_code - One-time registration codes

FS::reg_code_pkg - Class linking registration codes (see [[Freeside:1.9:Documentation:Developer/ FS/reg code|FS::reg_code]]) with package definitions (see FS::part_pkg)

FS::rate - Rate plans for call billing

FS::rate_region - Rate regions for call billing

FS::rate_prefix - Rate region prefixes for call billing

FS::rate_detail - Rate plan detail for call billing

FS::agent - Agent (reseller) class

FS::agent_type - Agent type class

FS::type_pkgs - Class linking agent types (see [[Freeside:1.9:Documentation:Developer/FS/agent type |FS::agent_type]]) with package definitions (see FS::part_pkg)

FS::cust_svc - Service class

FS::cust_pkg - Customer package class

FS::cust_pkg_option - Customer package option class

FS::cust_main - Customer class

FS::cust_main_invoice - Invoice destination class

FS::cust_bill - Invoice class

FS::cust_bill_pkg - Invoice line item class

FS::cust_bill_pkg_detail - Invoice line item detail class

FS::part_bill_event - Invoice event definition class

FS::cust_bill_event - Completed invoice event class

FS::cust_pay - Payment class

FS::cust_pay_void - Voided payment class

FS::cust_bill_pay - Payment application class

FS::cust_credit - Credit class

FS::cust_refund - Refund class

FS::cust_credit_refund - Refund application to credit class

FS::cust_credit_bill - Credit application to invoice class

FS::cust_pay_refund - Refund application to payment class

FS::pay_batch - Credit card transaction queue class

FS::cust_pay_batch - Credit card transaction member queue class

FS::prepay_credit - Prepaid "calling card" credit class.

FS::nas - Network Access Server class

FS::port - NAS port class

FS::session - User login session class

FS::queue - Job queue

FS::queue_arg - Job arguments

FS::queue_depend - Job dependencies

FS::msgcat - Message catalogs

FS::clientapi_session

FS::clientapi_session_field

Client API

FS::ClientAPI

FS::ClientAPI_SessionCache

FS::ClientAPI::Signup

FS::ClientAPI::passwd

FS::ClientAPI::MyAccount

FS::ClientAPI::Agent

Remote API modules

FS::SelfService

FS::SignupClient

FS::SessionClient

FS::MailAdminServer (deprecated in favor of the self-service server)

Command-line utilities

freeside-adduser

freeside-queued

freeside-daily

freeside-expiration-alerter

freeside-email

freeside-cc-receipts-report

freeside-credit-report

freeside-receivables-report

freeside-tax-report

freeside-bill

freeside-overdue

User Interface classes

FS::UI::Web - Web user-interface class

Notes

To quote perl(1), "If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references."

If you've never used OO modules before, http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.

DESCRIPTION

Freeside is a billing and administration package for Internet Service Providers.

The Freeside home page is at <http://www.sisd.com/freeside>.

The main documentation is in httemplate/docs.

SUPPORT

A mailing list for users is available. Send a blank message to <freeside-users-subscribe@sisd.com> to subscribe.

A mailing list for developers is available. It is intended to be lower volume and higher SNR than the users list. Send a blank message to <freeside-devel-subscribe@sisd.com> to subscribe.

Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.

AUTHOR

Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.

See the CREDITS file in the Freeside distribution for a (hopefully) complete list and the individal files for details.

SEE ALSO

perl(1), main Freeside documentation in htdocs/docs/

BUGS

Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP...