|
1 # -*- coding: utf-8 -*- |
|
2 from .user import with_user |
|
3 |
|
4 class Interface(object): |
|
5 '''class for a xmlrpc user |
|
6 ''' |
|
7 |
|
8 @with_user |
|
9 def status(self, user, id=None, detailed=False): |
|
10 '''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück. |
|
11 |
|
12 Keywords: |
|
13 apikey[string]: Der API Key |
|
14 id[hash]: Eine Auftragsnummer |
|
15 detailed[boolean]: Details ausgeben |
|
16 |
|
17 Return: |
|
18 jobs[list]: Eine Liste der Aufträge. |
|
19 job.name[string]: Angebener Name |
|
20 job.status[string]: Status des Auftrages |
|
21 |
|
22 |
|
23 ''' |
|
24 print user |
|
25 return str(user) |
|
26 #return user.status(id,detailed) |
|
27 return "" |
|
28 |
|
29 @with_user |
|
30 def stop(self, user, id): |
|
31 '''Stoppt den angegeben Auftrag. |
|
32 |
|
33 Keywords: |
|
34 apikey[string]: Der API Key |
|
35 id[hash]: Eine Auftragsnummer |
|
36 |
|
37 Return: |
|
38 |
|
39 ''' |
|
40 return "" |
|
41 |
|
42 @with_user |
|
43 def sms(self, user, message, recipients, route="default"): |
|
44 '''Versendet eine SMS. |
|
45 |
|
46 Keywords: |
|
47 apikey[string]: Der API Key |
|
48 message[string]: Nachricht |
|
49 recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
50 route[string|list]: Route über den geschickt werden soll, |
|
51 oder eine Liste von Routen, um Fallbacks anzugeben |
|
52 |
|
53 Return: |
|
54 id[hash]: Die ID des Auftrages |
|
55 |
|
56 ''' |
|
57 return "" |
|
58 |
|
59 @with_user |
|
60 def fax(self, user, subject, fax, recipients, route="default"): |
|
61 '''Versendet ein FAX. |
|
62 |
|
63 Keywords: |
|
64 apikey[string]: Der API Key |
|
65 subject[string]: Der Betreff |
|
66 fax[string]: Das PDF base64 kodiert |
|
67 recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
68 route[string|list]: Route über den geschickt werden soll, |
|
69 oder eine Liste von Routen, um Fallbacks anzugeben |
|
70 |
|
71 Return: |
|
72 id[hash]: Die ID des Auftrages |
|
73 |
|
74 ''' |
|
75 return "" |
|
76 |
|
77 @with_user |
|
78 def mail(self, user, subject, body, recipients, frm, route="default"): |
|
79 '''Versendet eine Email. |
|
80 |
|
81 Keywords: |
|
82 apikey[string]: Der API Key |
|
83 subject[string]: Der Betreff |
|
84 body[string]: Der Email Body |
|
85 recipients[list]: Eine Liste von Emailadressen |
|
86 frm[string]: Die Absender Emailadresse |
|
87 route[string|list]: Route über den geschickt werden soll, |
|
88 oder eine Liste von Routen, um Fallbacks anzugeben |
|
89 |
|
90 Return: |
|
91 id[hash]: Die ID des Auftrages |
|
92 |
|
93 ''' |
|
94 return "" |
|
95 |
|
96 @with_user |
|
97 def routes(self, user, typ): |
|
98 '''Gibt eine Liste aller verfügbaren Provider zurück. |
|
99 |
|
100 Keywords: |
|
101 apikey[string]: Der API Key |
|
102 typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
|
103 Einer der Liste ["sms","fax","mail"] |
|
104 |
|
105 Return: |
|
106 providerlist[list]: Eine Liste aller möglichen Provider |
|
107 |
|
108 ''' |
|
109 return "" |
|
110 |
|
111 @with_user |
|
112 def defaultRoute(self, user, typ): |
|
113 '''Gibt den Standardprovider zurück. |
|
114 |
|
115 Keywords: |
|
116 apikey[string]: Der API Key |
|
117 typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
|
118 Einer der Liste ["sms","fax","mail"] |
|
119 |
|
120 Return: |
|
121 provider[string]: Der Standardprovider für den angeben Typ |
|
122 |
|
123 |
|
124 ''' |
|
125 return "" |
|
126 |
|
127 @with_user |
|
128 def statistic(self, user): |
|
129 '''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises. |
|
130 |
|
131 Keywords: |
|
132 apikey[string]: Der API Key |
|
133 |
|
134 Return: |
|
135 statistic[list]: Eine Liste nach Nachrichtentypen |
|
136 ''' |
|
137 return "" |
|
138 |
|
139 |