--- a/iro/controller/viewinterface.py Wed Apr 25 00:04:47 2012 +0200
+++ b/iro/controller/viewinterface.py Wed Apr 25 00:05:53 2012 +0200
@@ -101,7 +101,7 @@
:param route: route to use to send, or a list of routes as fallback
:type route: string|list
:param string info: a name, to combine different jobs to one billing group
-
+ :param string frm: sender mail address
:return integer: the job id
'''
d = createJob(user, recipients, Mail(subject, body, frm), route, info)
@@ -132,6 +132,7 @@
'''Returns all default offernames.
:param string user: apikey of a user
+ :param string typ: a typ of message -- one of in this list ["sms","fax","mail"]
:return list: a list of all possible offer names for a typ
'''
@@ -186,7 +187,7 @@
:param list recipients: a list of telnumbers (use ITU-T E.123)
- :return: True -- all numbers are valid
+ :return boolean: True -- all numbers are valid
'''
return True
@@ -196,6 +197,6 @@
:param list recipients: a list of mailadresses
- :return: True -- all addresses are valid
+ :return boolean: True -- all addresses are valid
'''
return True
--- a/iro/model/schema.py Wed Apr 25 00:04:47 2012 +0200
+++ b/iro/model/schema.py Wed Apr 25 00:05:53 2012 +0200
@@ -185,7 +185,7 @@
return session.query(cls).filter_by(id=id).first()
class User(Base):
- """One user in iro"""
+ """An user in iro."""
__tablename__ = "apiuser"
name = Column(String(100), primary_key=True)
--- a/iro/offer/provider.py Wed Apr 25 00:04:47 2012 +0200
+++ b/iro/offer/provider.py Wed Apr 25 00:05:53 2012 +0200
@@ -35,7 +35,7 @@
pass
def getSendFunc(self, typ, route):
- """Returns the actually send Functionfor a given typ and route.
+ """Returns the actually send function for a given typ and route.
Normally it returns the send function with typ and route bound.
--- a/iro/offer/smstrade.py Wed Apr 25 00:04:47 2012 +0200
+++ b/iro/offer/smstrade.py Wed Apr 25 00:05:53 2012 +0200
@@ -94,10 +94,10 @@
Provider.__init__(self, name, {"sms":["basic","economy","gold","direct"]},options)
def send(self, route, recipient, sms):
- """send on SMS to recipients via route
+ """send one SMS to recipient via route
:param string route: A valid route ``["basic", "economy", "gold", "direct"]``
- :param string recipient: Mobilenumber of recipient
+ :param `iro.telnumber.Telnumber` recipient: Mobilenumber of recipient
:param `iro.model.message.SMS` sms: the sms to send
:return:
- All went ok -- :class:`iro.model.status.Status` object