--- a/iro/newuser.py Wed Dec 21 22:07:48 2011 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,138 +0,0 @@
-# -*- coding: utf-8 -*-
-#Copyright (C) 2009 Sandro Knauß <bugs@sandroknauss.de>
-
-#This program is free software; you can redistribute it and/or modify it under the terms
-#of the GNU General Public License as published by the Free Software Foundation;
-#either version 3 of the License, or any later version.
-#This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-#without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-#See the GNU General Public License for more details.
-
-#You should have received a copy of the GNU General Public License
-#along with this program; if not, see <http://www.gnu.org/licenses/>.
-
-class User:
- '''
- class for a xmlrpc user
- '''
-
- def status(self, apikey, id=None, detailed=False):
- u'''Gibt den aktuellen Status eines Auftrages zurück.
-
- Keywords:
- apikey[string]: Der API Key
- id[hash]: Eine Auftragsnummer
- detailed[boolean]: Details ausgeben
-
- Return:
- jobs[list]: Eine Liste der Aufträge.
- job.name[string]: Angebener Name
- job.status[string]: Status des Auftrages
-
-
- '''
- pass
-
- def stop(self, apikey,id):
- u'''Stoppt den angegeben Auftrag.
-
- Keywords:
- apikey[string]: Der API Key
- id[hash]: Eine Auftragsnummer
-
- Return:
-
- '''
- pass
-
- def sms(self, apikey, message, recipients, route="default"):
- u'''Versendet eine SMS.
-
- Keywords:
- apikey[string]: Der API Key
- message[string]: Nachricht
- recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
- route[string|list]: Route über den geschickt werden soll,
- oder eine Liste von Routen, um Fallbacks anzugeben
-
- Return:
- id[hash]: Die ID des Auftrages
-
- '''
- pass
-
-
- def fax(self, apikey, subject, fax, recipients, route="default"):
- u'''Versendet ein FAX.
-
- Keywords:
- apikey[string]: Der API Key
- subject[string]: Der Betreff
- fax[string]: Das PDF base64 kodiert
- recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
- route[string|list]: Route über den geschickt werden soll,
- oder eine Liste von Routen, um Fallbacks anzugeben
-
- Return:
- id[hash]: Die ID des Auftrages
-
- '''
- pass
-
- def mail(self, apikey, subject, body, recipients, frm, route="default"):
- u'''Versendet eine Email.
-
- Keywords:
- apikey[string]: Der API Key
- subject[string]: Der Betreff
- body[string]: Der Email Body
- recipients[list]: Eine Liste von Emailadressen
- frm[string]: Die Absender Emailadresse
- route[string|list]: Route über den geschickt werden soll,
- oder eine Liste von Routen, um Fallbacks anzugeben
-
- Return:
- id[hash]: Die ID des Auftrages
-
- '''
- pass
-
- def routes(self, apikey, typ):
- u'''Gibt eine Liste aller verfügbaren Provider zurück.
-
- Keywords:
- apikey[string]: Der API Key
- typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
- Einer der Liste ["sms","fax","mail"]
-
- Return:
- providerlist[list]: Eine Liste aller möglichen Provider
-
- '''
- pass
-
- def defaultRoute(self, apikey, typ):
- u'''Gibt den Standardprovider zurück.
-
- Keywords:
- apikey[string]: Der API Key
- typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
- Einer der Liste ["sms","fax","mail"]
-
- Return:
- provider[string]: Der Standardprovider für den angeben Typ
-
-
- '''
- pass
-
- def statistic(self,apikey):
- u'''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises.
-
- Keywords:
- apikey[string]: Der API Key
-
- Return:
- statistic[list]: Eine Liste nach Nachrichtentypen
- '''
- pass