# -*- coding: utf-8 -*-
from ..model.user import with_user

class Interface(object):
    '''class for a xmlrpc user
    '''
    
    @with_user
    def status(self, user, id=None, detailed=False):
        '''Gibt den aktuellen Status eines Auftrages oder Mehreren 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


        '''
        return str(user)
        #return user.status(id,detailed)
        return ""

    @with_user
    def stop(self, user, id):
        '''Stoppt den angegeben Auftrag.

        Keywords:
        apikey[string]: Der API Key
        id[hash]: Eine Auftragsnummer

        Return:

        '''
        return ""
    
    @with_user
    def sms(self, user, message, recipients, route="default"):
        '''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

        '''
        return ""
   
    @with_user
    def fax(self, user, subject, fax, recipients, route="default"):
        '''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

        '''
        return ""

    @with_user
    def mail(self, user, subject,  body, recipients, frm, route="default"):
        '''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

        '''
        return ""
       
    @with_user
    def routes(self, user, typ):
        '''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

        '''
        return ""
        
    @with_user
    def defaultRoute(self, user, typ):
        '''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


        '''
        return ""

    @with_user
    def statistic(self, user):
        '''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
        '''
        return ""