Python API¶
odorik
¶
OdorikException
¶
-
exception
odorik.
OdorikException
¶ Základní třída pro výjimky.
Odorik
¶
-
Odorik(user='', password='', url=None, config=None):
Parametry: - user (string) – ID uživatele
- password (string) – API heslo
- url (string) – URL API serveru, pokud není zadáno použije se výchozí
- config (OdorikConfig) – Objekt s nastaveními, přepíše jakékoliv jiné parametry.
Hlavní třída pro přístup k API. Zadejte uživatele, heslo a volitelně URL API.
-
odorik.
get
(path, args=None)¶ Parametry: - path (string) – Cesta požadavku
- args (dict) – Volitelné parametry požadavku
Typ návratové hodnoty: string
Provede jeden GET API požadavek.
-
odorik.
get_json
(path, args=None)¶ Parametry: - path (string) – Cesta požadavku
- args (dict) – Volitelné parametry požadavku
Typ návratové hodnoty: object
Provede jeden GET API požadavek a zpracuje odpověď ve formátu JSON včetně případného ošetření chyb.
-
odorik.
balance
()¶ Typ návratové hodnoty: float Vrátí aktuální zůstatek.
-
odorik.
mobile_data
(from_date, to_date, number=None)¶ Parametry: - from_date (datetime.datetime) – Počáteční datum
- to_date (datetime.datetime) – Koncové datum
- number (string) – Telefonní číslo ve tvaru 00420789123456
Typ návratové hodnoty: list
Vrátí využití dat v zadaném časovém intervalu. Volitelně může být filtrován pro zadanou linku.
-
odorik.
send_sms
(recipient, message, sender='5517')¶ Parametry: - recipient (string) – Číslo kam odeslat SMS.
- message (string) – Text zprávy.
- sender (string) – Volitelné číslo odesílatele.
Typ návratové hodnoty: string
Odešle SMS zprávu.
-
odorik.
callback
(caller, recipient, line=None)¶ Parametry: - caller (string) – Číslo, které volá.
- recipient (string) – Číslo, které se má zavolat.
- line (string or None) – Jakou linku použít pro vyúčtování.
Typ návratové hodnoty: string
Objedná zpětné volání.
-
calls(from_date, to_date, line=None, status=None, direction=None):
Parametry: - from_date (datetime.datetime) – Počáteční datum
- to_date (datetime.datetime) – Koncové datum
- line (string or None) – Jakou linku použít pro výpis
- status (string) – Stav hovoru, jedno z ‚answered‘, ‚missed‘
- direction (string) – Směr hovoru, jedno z ‚in‘, ‚out‘, ‚redirected‘
Typ návratové hodnoty: list
Vrátí seznam hovorů v zadaném časovém intervalu. Volitelně může být filtrován pro zadanou linku.
-
sms(from_date, to_date, line=None):
Parametry: - from_date (datetime.datetime) – Počáteční datum
- to_date (datetime.datetime) – Koncové datum
- line (string or None) – Jakou linku použít pro výpis
Typ návratové hodnoty: list
Vrátí seznam SMS v zadaném časovém intervalu. Volitelně může být filtrován pro zadanou linku.
-
odorik.
lines
()¶ Typ návratové hodnoty: list Vrátí seznam slovníků s informacemi o linkách.
odorik.config
¶
OdorikConfig
¶
-
class
odorik.config.
OdorikConfig
(section='odorik')¶ Parametry: section (string) – Jakou sekci konfiguračního použít Zpracování konfiguračního souboru podle specifikace XDG.
-
load
(path=None)¶ Parametry: path (string) – Cesta k souboru s konfigurací. Načte nastavení z konfiguračního souboru. Pokud není zadána cesta, použije se soubor odorik umístěný v cestě XDG (
~/.config/odorik
a/etc/xdg/odorik
).
-
odorik.main
¶
-
odorik.main.
main
(settings=None, stdout=None, args=None)¶ Parametry: - settings (list of tuples) – vynutit změnu těchto nastavení
- stdout (file) – výstup pro vypisování textu, pokud není zadáno použije
sys.stdout
- args (list) – parametry z příkazové řádky pro zpracování, pokud není zadáno použije
sys.args
Hlavní funkce pro příkazovou řádku.