equal
deleted
inserted
replaced
10 |
10 |
11 #You should have received a copy of the GNU General Public License |
11 #You should have received a copy of the GNU General Public License |
12 #along with this program; if not, see <http://www.gnu.org/licenses/>. |
12 #along with this program; if not, see <http://www.gnu.org/licenses/>. |
13 |
13 |
14 class User: |
14 class User: |
15 ''' |
15 '''class for a xmlrpc user |
16 class for a xmlrpc user |
|
17 ''' |
16 ''' |
18 |
17 |
19 def status(self, apikey, id=None, detailed=False): |
18 def status(self, apikey, id=None, detailed=False): |
20 u'''Gibt den aktuellen Status eines Auftrages zurück. |
19 '''Gibt den aktuellen Status eines Auftrages zurück. |
21 |
20 |
22 Keywords: |
21 Keywords: |
23 apikey[string]: Der API Key |
22 apikey[string]: Der API Key |
24 id[hash]: Eine Auftragsnummer |
23 id[hash]: Eine Auftragsnummer |
25 detailed[boolean]: Details ausgeben |
24 detailed[boolean]: Details ausgeben |
32 |
31 |
33 ''' |
32 ''' |
34 pass |
33 pass |
35 |
34 |
36 def stop(self, apikey,id): |
35 def stop(self, apikey,id): |
37 u'''Stoppt den angegeben Auftrag. |
36 '''Stoppt den angegeben Auftrag. |
38 |
37 |
39 Keywords: |
38 Keywords: |
40 apikey[string]: Der API Key |
39 apikey[string]: Der API Key |
41 id[hash]: Eine Auftragsnummer |
40 id[hash]: Eine Auftragsnummer |
42 |
41 |
44 |
43 |
45 ''' |
44 ''' |
46 pass |
45 pass |
47 |
46 |
48 def sms(self, apikey, message, recipients, route="default"): |
47 def sms(self, apikey, message, recipients, route="default"): |
49 u'''Versendet eine SMS. |
48 '''Versendet eine SMS. |
50 |
49 |
51 Keywords: |
50 Keywords: |
52 apikey[string]: Der API Key |
51 apikey[string]: Der API Key |
53 message[string]: Nachricht |
52 message[string]: Nachricht |
54 recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
53 recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
61 ''' |
60 ''' |
62 pass |
61 pass |
63 |
62 |
64 |
63 |
65 def fax(self, apikey, subject, fax, recipients, route="default"): |
64 def fax(self, apikey, subject, fax, recipients, route="default"): |
66 u'''Versendet ein FAX. |
65 '''Versendet ein FAX. |
67 |
66 |
68 Keywords: |
67 Keywords: |
69 apikey[string]: Der API Key |
68 apikey[string]: Der API Key |
70 subject[string]: Der Betreff |
69 subject[string]: Der Betreff |
71 fax[string]: Das PDF base64 kodiert |
70 fax[string]: Das PDF base64 kodiert |
78 |
77 |
79 ''' |
78 ''' |
80 pass |
79 pass |
81 |
80 |
82 def mail(self, apikey, subject, body, recipients, frm, route="default"): |
81 def mail(self, apikey, subject, body, recipients, frm, route="default"): |
83 u'''Versendet eine Email. |
82 '''Versendet eine Email. |
84 |
83 |
85 Keywords: |
84 Keywords: |
86 apikey[string]: Der API Key |
85 apikey[string]: Der API Key |
87 subject[string]: Der Betreff |
86 subject[string]: Der Betreff |
88 body[string]: Der Email Body |
87 body[string]: Der Email Body |
96 |
95 |
97 ''' |
96 ''' |
98 pass |
97 pass |
99 |
98 |
100 def routes(self, apikey, typ): |
99 def routes(self, apikey, typ): |
101 u'''Gibt eine Liste aller verfügbaren Provider zurück. |
100 '''Gibt eine Liste aller verfügbaren Provider zurück. |
102 |
101 |
103 Keywords: |
102 Keywords: |
104 apikey[string]: Der API Key |
103 apikey[string]: Der API Key |
105 typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
104 typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
106 Einer der Liste ["sms","fax","mail"] |
105 Einer der Liste ["sms","fax","mail"] |
110 |
109 |
111 ''' |
110 ''' |
112 pass |
111 pass |
113 |
112 |
114 def defaultRoute(self, apikey, typ): |
113 def defaultRoute(self, apikey, typ): |
115 u'''Gibt den Standardprovider zurück. |
114 '''Gibt den Standardprovider zurück. |
116 |
115 |
117 Keywords: |
116 Keywords: |
118 apikey[string]: Der API Key |
117 apikey[string]: Der API Key |
119 typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
118 typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
120 Einer der Liste ["sms","fax","mail"] |
119 Einer der Liste ["sms","fax","mail"] |
125 |
124 |
126 ''' |
125 ''' |
127 pass |
126 pass |
128 |
127 |
129 def statistic(self,apikey): |
128 def statistic(self,apikey): |
130 u'''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises. |
129 '''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises. |
131 |
130 |
132 Keywords: |
131 Keywords: |
133 apikey[string]: Der API Key |
132 apikey[string]: Der API Key |
134 |
133 |
135 Return: |
134 Return: |