--- a/iro/controller/viewinterface.py Fri Mar 30 11:23:22 2012 +0200
+++ b/iro/controller/viewinterface.py Fri Mar 30 11:49:13 2012 +0200
@@ -14,15 +14,15 @@
@vUser
@dbdefer
def status(self, session, user, id=None, detailed=False):
- '''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück.
+ '''Returns the status of one or more jobs.
- :param string apikey: der API Key
- :param hash id: Eine Auftragsnummer
- :param `boolean` detailed: Details ausgeben
+ :param string user: apikey of a user
+ :param integer id: one job id
+ :param `boolean` detailed: return more details about the status
:return dict:
- - `key` ist die Auftragsnummer
- - [`key`][**'status'**] -- Status des Auftrages
+ - `key` -- is the job id
+ - [`key`][**'status'**] -- status of the job
.. warning:: detailed is not used yet.
@@ -31,7 +31,7 @@
"2": {"status":"error"},
"10": {"status":"sending"}}
- >>> status(APIKEY,"10")
+ >>> status(APIKEY,10)
{"10": {"status":"sending"}}
'''
user = session.merge(user)
@@ -48,18 +48,16 @@
@vUser
@validate(kwd="route", func=vRoute, typ="sms")
def sms(self, user, message, recipients, route="default", info=""):
- '''Versendet eine SMS.
+ '''Send a sms.
- :param string apikey: Der API Key
- :param string message: Nachricht
- :param list recipients: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
- :param route: Route über den geschickt werden soll,
- oder eine Liste von Routen, um Fallbacks anzugeben
+ :param string user: apikey of a user
+ :param string message: message
+ :param list recipients: a list of telefon numbers (use ITU-T E.123)
+ :param route: route to use to send, or a list of routes as fallback
:type route: string|list
- :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.
+ :param string info: a name, to combine different jobs to one billing group
- :return hash: Die ID des Auftrages
-
+ :return integer: the job id
'''
d = createJob(user, recipients, SMS(message), route, info)
def ret(job):
@@ -71,18 +69,17 @@
@vUser
@validate(kwd="route",func=vRoute, typ="fax")
def fax(self, user, subject, fax, recipients, route="default", info=""):
- '''Versendet ein FAX.
+ '''Send a fax.
- :param string apikey: Der API Key
- :param string subject: Der Betreff
- :param string fax: Der base64 kodierte content
- :param list recipients: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
- :param route: Route über den geschickt werden soll,
- oder eine Liste von Routen, um Fallbacks anzugeben
+ :param string user: apikey of a user
+ :param string subject: subject
+ :param string fax: content (base64 encoded)
+ :param list recipients: a list of telefon numbers (use ITU-T E.123)
+ :param route: route to use to send, or a list of routes as fallback
:type route: string|list
- :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.
+ :param string info: a name, to combine different jobs to one billing group
- :return hash: Die ID des Auftrages
+ :return integer: the job id
'''
d = createJob(user, recipients, Fax(subject, fax), route, info)
def ret(job):
@@ -95,21 +92,18 @@
@vUser
@validate(kwd="route",func=vRoute, typ="mail")
def mail(self, user, subject, body, recipients, frm=None, route="default", info=""):
- '''Versendet eine Email.
+ '''Send a mail.
- :param string apikey: Der API Key
- :param string subject: Der Betreff
- :param string body: Der Email Body
- :param list recipients: Eine Liste von Emailadressen
- :param string frm: Die Absender Emailadresse
- :param route: Route über den geschickt werden soll,
- oder eine Liste von Routen, um Fallbacks anzugeben
+ :param string user: apikey of a user
+ :param string subject: subject
+ :param string body: mail body
+ :param list recipients: a list of email addresses
+ :param route: route to use to send, or a list of routes as fallback
:type route: string|list
- :param string info: Infostring um eine Nachricht einer Gruppe zuorden zu können.
+ :param string info: a name, to combine different jobs to one billing group
- :return hash: Die ID des Auftrages
+ :return integer: the job id
'''
-
d = createJob(user, recipients, Mail(subject, body, frm), route, info)
def ret(job):
return job.dbjob
@@ -120,13 +114,12 @@
@vUser
@dbdefer
def routes(self, session, user, typ):
- '''Gibt eine Liste aller verfügbaren Provider zurück.
+ '''Returns a list of all possible offernames.
- :param string apikey: Der API Key
- :param string typ: Der Typ zu dem die Providerloste ausgeben werden soll
- Einer der Liste ["sms","fax","mail"]
+ :param string user: apikey of a user
+ :param string typ: a typ of message -- one of in this list ["sms","fax","mail"]
- :return list: Eine Liste aller möglichen Provider
+ :return list: a list of all possible offer names for a typ
'''
user = session.merge(user)
offers = user.routes(typ)
@@ -136,13 +129,11 @@
@vUser
@dbdefer
def defaultRoute(self, session, user, typ):
- '''Gibt den Standardprovider zurück.
+ '''Returns all default offernames.
- :param string apikey: Der API Key
- :param string typ: Der Typ zu dem die Providerliste ausgeben werden soll
- Einer der Liste ["sms","fax","mail"]
+ :param string user: apikey of a user
- :return string: Der Standardprovider für den angeben Typ
+ :return list: a list of all possible offer names for a typ
'''
user = session.merge(user)
offers = user.routes(typ, default=True)
@@ -151,16 +142,16 @@
@vUser
@dbdefer
def bill(self, session, user):
- '''Gibt eine Rechnung zurück über die noch nicht abgerechneten Nachrichten und des Preises.
+ '''Returns the bill, of not paid messages.
- :param string apikey: Der API Key
+ :param string user: apikey of a user
:return dict:
- - `route` -- Entspricht einer Route; **"total"** für die Gesammtübersicht
- - [`route`][`info`][**anz**] -- Anzahl der verschickten Nachrichten pro "Infoklasse"
- - [`route`][`info`][**price**] -- Preis pro "Infoklasse"
- - [`route` | **total**][**anz**] -- Anzahl der verschickten Nachrichten pro Route
- - [`route` | **total**][**price**] -- Preis für eine Route
+ - `route` -- one offer name ; **"total"** complete sum
+ - [`route`][`info`][**anz**] -- Number of sended messages in one billing group
+ - [`route`][`info`][**price**] -- Price for one billing group
+ - [`route` | **total**][**anz**] -- Number of sended messages for one offer
+ - [`route` | **total**][**price**] -- Price for one offer
>>> bill(APIKEY)
{"route1": {"info1":{"anz":1,"price":2.00},
@@ -191,20 +182,20 @@
@validate(kwd="recipients",func=vTel)
def telnumber(self,recipients):
- '''Gibt True zurück, falls alle übergebene Telefonnummern valide sind.
+ '''Return True, if all telnumbers a vaild.
- :param list recipients: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
+ :param list recipients: a list of telnumbers (use ITU-T E.123)
- :return: True -- alle übergebene Nummern sind valide
+ :return: True -- all numbers are valid
'''
return True
@validate(kwd="recipients",func=vEmail)
def email(self,recipients):
- '''Gibt True zurück, falls alle übergebene Emailadressen valide sind.
+ '''Return True, if all mailadresses a valid.
- :param list recipients: Eine Liste von Emailadressen
+ :param list recipients: a list of mailadresses
- :return: True -- alle übergebene Nummern sind valide
+ :return: True -- all addresses are valid
'''
return True