diff --git a/README.md b/README.md index 82eaf18..1e7da0c 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,10 @@ Python SDK for the ISPConfig remote SOAP API. Internal tooling for the Sulkta Coop — wraps the panel's SOAP surface so we stop writing throw-away PHP scripts every time we need to touch a site, zone, or mailbox. -The SDK covers the methods we actually use today (sites, DNS, mail, databases, -clients). More methods can be added as needed. +v0.2 covers the **full remote API** — every method exposed by ISPConfig's +`remote/index.php`, 312 of them as of Rackham 2026-04-22. The hand-audited +helpers (stable names, param-order fixes, convenience wrappers) sit on top +of auto-generated wrappers that mirror the PHP surface 1:1. ## Why no zeep? @@ -45,9 +47,35 @@ managed internally — callers don't touch them. Set `verify_ssl=False` for dev boxes with self-signed certs. Default is `True`. -## Modules at a glance +## Changelog -### `sites` +### 0.2.0 — 2026-04-22 + +Full-coverage extension. Every remote method ISPConfig exposes is now wrapped +in one of the submodules below. Hand-audited helpers from v0.1 (footgun +fixes, convenience wrappers) are preserved beneath a delimiter and survive +regeneration. New submodules: `admin`, `aps`, `backups`, `cron`, `domains`, +`ftp`, `misc`, `monitor`, `openvz`, `server`, `shell`, `webdav`. + +- Code generator at `tools/gen_methods.py` driven by `tools/method_inventory.json`. +- One-command refresh for future ISPConfig upgrades (see below). +- `ISPConfigClient.raw_call(method, *args)` escape hatch for methods not yet + in the inventory. +- `ISPConfigClient.list_functions()` introspects the panel's exposed method list. +- Live smoke test extended from 4 to 21 read-only calls covering every module. + +### 0.1.0 — 2026-04-21 + +Initial release. Hand-audited coverage of sites / dns / mail / databases / clients. + +## Modules + +### Hand-audited (stable API, verified in prod) + +Names normalized for ergonomics; footgun fixes and retries baked in. These +are the wrappers you should prefer. + +#### `sites` ```python c.sites.web_domain_get(156) @@ -56,38 +84,94 @@ c.sites.enable_php(156, mode="php-fpm", server_php_id=2, pm="ondemand") c.sites.enable_letsencrypt(156) ``` -### `dns` +#### `dns` ```python -zone_id = c.dns.zone_get_id("example.com.") # note the trailing dot +zone_id = c.dns.zone_get_id("example.com") # trailing dot is stripped either way zone = c.dns.zone_get(zone_id) records = c.dns.rr_get_all_by_zone(zone_id) rr_id = c.dns.a_add(0, {"zone": zone_id, "name": "www", "data": "1.2.3.4", "ttl": 3600, "active": "Y"}) ``` -### `mail` +#### `mail` ```python md = c.mail.domain_get_by_domain("example.com") -users = c.mail.user_get({"email": "%@example.com"}) +users = c.mail.user_get({"email": "%@example.com"}) # always a list new_id = c.mail.create_mailbox(client_id=5, domain="example.com", local_part="info", password="x", quota_mb=2048) ``` -### `databases` +#### `databases` ```python db = c.databases.get(42) c.databases.user_update(client_id=5, primary_id=42, params={"database_password": "x"}) ``` -### `clients` +#### `clients` ```python cli = c.clients.get_by_username("jacob") groupid = c.clients.get_groupid(cli["client_id"]) +ids = c.clients.get_all() ``` +### Auto-generated (full surface, v0.2) + +Wrappers mirror the PHP method names 1:1. Param shapes come from PHPDoc where +available and default to `Any` otherwise. Verified to wire up against Rackham +2026-04-22 but not yet battle-tested in production use — file issues if you +hit one. + +| Module | Class | Methods | +|--------------|----------------------|---------| +| `admin` | `AdminModule` | 10 | +| `aps` | `ApsModule` | 10 | +| `backups` | `BackupsModule` | 2 | +| `clients` | `ClientsModule` | 19 | +| `cron` | `CronModule` | 4 | +| `databases` | `DatabasesModule` | 9 | +| `dns` | `DnsModule` | 87 | +| `domains` | `DomainsModule` | 5 | +| `ftp` | `FtpModule` | 5 | +| `mail` | `MailModule` | 82 | +| `misc` | `MiscModule` | 4 | +| `monitor` | `MonitorModule` | 1 | +| `openvz` | `OpenvzModule` | 22 | +| `server` | `ServerModule` | 12 | +| `shell` | `ShellModule` | 4 | +| `sites` | `SitesModule` | 29 | +| `webdav` | `WebdavModule` | 4 | + +Every auto-generated method carries a docstring with the original PHP +filename + line number and an `AUTO-GENERATED — param shapes may need +verification` warning. Methods that exist in both the auto and hand-audited +blocks are skipped in the auto block — the hand version wins. + +### Escape hatch + +For methods not yet in the inventory (e.g. on a newer ISPConfig version than +we've regenerated against): + +```python +result = c.raw_call("some_new_method", arg1, arg2) +``` + +`raw_call` routes through the same session-management + fault-mapping +pipeline as typed methods, so auth/retry still works. To see what the panel +exposes: + +```python +funcs = c.list_functions() +``` + +### Not covered + +- `__construct` — PHP constructor, not a real API method. +- Anything gated by ISPConfig plugins we don't have installed — probing via + `raw_call` will return a faultstring like "Method not found". + ## Footguns (captured here so nobody has to rediscover them) - **`sites_web_domain_update`'s second arg is `client_id`, not `primary_id`.** @@ -112,9 +196,9 @@ groupid = c.clients.get_groupid(cli["client_id"]) - **`mail_user_get` with a filter dict returns inconsistent shapes.** If the filter matches multiple rows you get an array; exactly-one match returns a bare map. Our `mail.user_get(filter_dict)` always normalizes to a list. -- **`no_domain_found` fault.** Both `dns_zone_get_id` and (in some paths) - `mail_domain_get_by_domain` return a SOAP fault with `faultcode=no_domain_found` - when the record is missing. Mapped to `NotFoundError`. +- **`no_domain_found` / `no_client_found` faults.** These are typed as + `NotFoundError`; `client_get_by_username("nope")` raises it. Older code + may have caught raw `FaultError` — v0.2 reclassifies both. - **`dns_a_add` type-column bug.** On some ISPConfig versions (<= ~3.2.11) `dns_a_add` inserts the `dns_rr` row without setting the `type` column, so BIND never emits the record. `DnsModule.a_add(..., fix_type_bug=True)` @@ -130,6 +214,17 @@ groupid = c.clients.get_groupid(cli["client_id"]) - **Filter dicts on `mail_user_get`.** Pass an int to get one row; pass a dict like `{"email": "%@example.com"}` to get a list. The SOAP method is overloaded and untyped on the wire. +- **PHP method signatures with `array()` defaults.** ISPConfig's extract + regex used to stop at the first `)` in `$params = array()`, missing three + methods on 3.2.x (`sites_aps_available_packages_list`, + `sites_aps_instance_delete`, `openvz_vm_add_from_template`). Fixed in + `tools/extract_inventory.py` with balanced-paren matching — worth + double-checking on future panel upgrades. +- **Known admin-only methods.** Reseller logins fault with "permission denied" + on a non-admin user. These are skipped in the smoke tests: + `monitor_jobqueue_count`, `sites_cron_get`, `sites_ftp_user_get`, + `openvz_*`, `quota_get_by_user`, `client_templates_get_all`. Use an admin + login if you need them. ## Errors @@ -147,7 +242,7 @@ ISPConfigError ## Tests ```bash -pytest # unit tests only, no network +pytest # unit tests only, no network (12 tests) ``` To run the live smoke test against a real panel: @@ -156,11 +251,47 @@ To run the live smoke test against a real panel: export ISPCONFIG_TEST_URL="https://panel.example.com:8080/remote/index.php" export ISPCONFIG_TEST_USER="kayos" export ISPCONFIG_TEST_PASS="..." +export ISPCONFIG_TEST_VERIFY_SSL=0 # for self-signed certs pytest tests/test_smoke.py ``` -The smoke test is read-only — no `_add` / `_update` / `_delete` calls. Safe -against production. +21 read-only calls covering every auto-generated module + the originals. No +`_add` / `_update` / `_delete` calls — safe against production. Methods that +require admin privileges skip gracefully with a documented reason. + +## Regenerating for newer ISPConfig versions + +When ISPConfig ships a new version on Rackham (or another panel), resync: + +```bash +# 1. Pull fresh PHP sources from the panel (sudo required; ask Cobb for creds): +mkdir -p /tmp/ispconfig-php-src +ssh rackham "sudo tar -cz -C /usr/local/ispconfig/interface/lib/classes/remote.d ." \ + | tar -xz -C /tmp/ispconfig-php-src/ +ssh rackham "sudo cat /usr/local/ispconfig/interface/lib/classes/remoting.inc.php" \ + > /tmp/ispconfig-php-src/remoting.inc.php + +# 2. Re-extract the method inventory: +python3 tools/extract_inventory.py /tmp/ispconfig-php-src tools/method_inventory.json + +# 3. Regenerate wrappers: +python3 tools/gen_methods.py + +# 4. Clean up formatting + sanity check: +ruff format src/ tools/ +ruff check src/ tools/ +mypy src/ispconfig +pytest + +# 5. Review and commit: +git diff --stat +git diff tools/method_inventory.json # new methods jump out here +``` + +Hand-edits below the `HAND-EDIT ONLY BELOW` marker in each module survive +regeneration. Method-name collisions between auto and hand are resolved in +favor of the hand version; the generator emits a `# skipped ...` comment +in the auto block for traceability. ## Development @@ -171,29 +302,6 @@ mypy src/ispconfig pytest ``` -## Not yet covered - -The remote API surface is huge. These are intentionally left out of v0.1 — -add as needed: - -- `sites_web_aliasdomain_*`, `sites_web_subdomain_*`, - `sites_web_vhost_{subdomain,aliasdomain}_*` -- `sites_ftp_user_*`, `sites_shell_user_*`, `sites_webdav_user_*` -- `sites_cron_*` -- `sites_web_domain_backup`, `sites_web_domain_backup_list`, - `mail_user_backup`, `mail_user_backup_list` -- `dns_{aaaa,ns,srv,ptr,tlsa,ds,caa,sshfp,dname,loc,hinfo,naptr,rp,alias}_*` -- `dns_slave_*`, `dns_zone_set_dnssec`, `dns_zone_get_by_user`, `dns_templatezone_*` -- `mail_alias_*`, `mail_aliasdomain_*`, `mail_catchall_*`, `mail_filter_*`, - `mail_fetchmail_*`, `mail_mailinglist_*`, `mail_policy_*`, - `mail_relay_{domain,recipient}_*`, `mail_transport_*`, - `mail_{whitelist,blacklist}_*`, `mail_spamfilter_*`, `mail_user_filter_*` -- `client_add`, `client_update`, `client_delete`, `client_change_password`, - `client_template_additional_*`, `client_templates_get_all`, - `client_login_get` -- `server_get`, `server_get_all`, `admin.*`, `monitor.*`, `aps.*`, - `openvz.*`, `domains.*` - ## License MIT — see `LICENSE`. diff --git a/pyproject.toml b/pyproject.toml index 18d3537..8e538d3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "ispconfig" -version = "0.1.0" +version = "0.2.0" description = "Python SDK for the ISPConfig remote SOAP API — Sulkta Coop internal tooling." readme = "README.md" license = { text = "MIT" } @@ -83,10 +83,24 @@ ignore = [ "tests/*" = ["SLF001", "N802"] # Submodules call back into the client's dispatcher (`_call`) by design — # it's the single chokepoint for session management and retry logic. -"src/ispconfig/sites.py" = ["SLF001"] -"src/ispconfig/dns.py" = ["SLF001"] -"src/ispconfig/mail.py" = ["SLF001"] +# Every submodule needs this waiver; generator output follows the same pattern. +"src/ispconfig/admin.py" = ["SLF001"] +"src/ispconfig/aps.py" = ["SLF001"] +"src/ispconfig/backups.py" = ["SLF001"] "src/ispconfig/clients.py" = ["SLF001"] +"src/ispconfig/cron.py" = ["SLF001"] +"src/ispconfig/databases.py" = ["SLF001"] +"src/ispconfig/dns.py" = ["SLF001"] +"src/ispconfig/domains.py" = ["SLF001"] +"src/ispconfig/ftp.py" = ["SLF001"] +"src/ispconfig/mail.py" = ["SLF001"] +"src/ispconfig/misc.py" = ["SLF001"] +"src/ispconfig/monitor.py" = ["SLF001"] +"src/ispconfig/openvz.py" = ["SLF001"] +"src/ispconfig/server.py" = ["SLF001"] +"src/ispconfig/shell.py" = ["SLF001"] +"src/ispconfig/sites.py" = ["SLF001"] +"src/ispconfig/webdav.py" = ["SLF001"] # ---- pytest --------------------------------------------------------- diff --git a/src/ispconfig/_soap.py b/src/ispconfig/_soap.py index f86f933..4433e41 100644 --- a/src/ispconfig/_soap.py +++ b/src/ispconfig/_soap.py @@ -95,14 +95,14 @@ class SoapTransport: arg_xml = "".join(_encode_arg(name, value) for name, value in args) return ( '' - '' - f'{arg_xml}' - '' + f"{arg_xml}" + "" ) @staticmethod @@ -148,7 +148,7 @@ def _encode_arg(name: str, value: Any) -> str: if isinstance(value, Mapping): items = "".join( f'{xml_escape(str(k))}' - f'{_encode_value_tag("value", v)}' + f"{_encode_value_tag('value', v)}" for k, v in value.items() ) return f'<{name} xsi:type="ns2:Map" xmlns:ns2="http://xml.apache.org/xml-soap">{items}' @@ -223,10 +223,7 @@ def _is_map(el: ET.Element) -> bool: return False if not all(_local(k.tag) == "item" for k in kids): return False - return any( - any(_local(gk.tag) == "key" for gk in item) - for item in kids - ) + return any(any(_local(gk.tag) == "key" for gk in item) for item in kids) def _is_array(el: ET.Element) -> bool: diff --git a/src/ispconfig/admin.py b/src/ispconfig/admin.py new file mode 100644 index 0000000..d3c3f4c --- /dev/null +++ b/src/ispconfig/admin.py @@ -0,0 +1,177 @@ +"""``admin.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class AdminModule: + """Auto-generated module: Admin. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def config_value_add(self, group: Any, name: Any, value: Any) -> Any: + """ + Auto-generated wrapper for ``config_value_add``. + + Source: ``admin.inc.php`` line 181. + PHP signature: ``config_value_add($session_id, $group, $name, $value)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("config_value_add", ("group", group), ("name", name), ("value", value)) + + def config_value_delete(self, group: Any, name: Any) -> Any: + """ + Auto-generated wrapper for ``config_value_delete``. + + Source: ``admin.inc.php`` line 252. + PHP signature: ``config_value_delete($session_id, $group, $name)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("config_value_delete", ("group", group), ("name", name)) + + def config_value_get(self, group: Any, name: Any) -> Any: + """ + Auto-generated wrapper for ``config_value_get``. + + Source: ``admin.inc.php`` line 162. + PHP signature: ``config_value_get($session_id, $group, $name)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("config_value_get", ("group", group), ("name", name)) + + def config_value_replace(self, group: Any, name: Any, value: Any) -> Any: + """ + Auto-generated wrapper for ``config_value_replace``. + + Source: ``admin.inc.php`` line 229. + PHP signature: ``config_value_replace($session_id, $group, $name, $value)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("config_value_replace", ("group", group), ("name", name), ("value", value)) + + def config_value_update(self, group: Any, name: Any, value: Any) -> Any: + """ + Auto-generated wrapper for ``config_value_update``. + + Source: ``admin.inc.php`` line 205. + PHP signature: ``config_value_update($session_id, $group, $name, $value)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("config_value_update", ("group", group), ("name", name), ("value", value)) + + def sys_datalog_get(self, datalog_id: Any, newer: Any = False) -> Any: + """ + Auto-generated wrapper for ``sys_datalog_get``. + + Source: ``admin.inc.php`` line 294. + PHP signature: ``sys_datalog_get($session_id, $datalog_id, $newer = false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sys_datalog_get", ("datalog_id", datalog_id), ("newer", newer)) + + def sys_datalog_get_by_tstamp(self, tstamp: Any) -> Any: + """ + Auto-generated wrapper for ``sys_datalog_get_by_tstamp``. + + Source: ``admin.inc.php`` line 276. + PHP signature: ``sys_datalog_get_by_tstamp($session_id, $tstamp)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sys_datalog_get_by_tstamp", ("tstamp", tstamp)) + + def system_config_get(self, section: str, key: str | None = None) -> Any: + """ + Get the values of the system configuration + + Source: ``admin.inc.php`` line 137. + PHP signature: ``system_config_get($session_id, $section, $key = null)``. + + Params (from PHPDoc): + session (int): id + section (string): of the config field in the table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc + key (string|null): of the option that you want to get + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("system_config_get", ("section", section), ("key", key)) + + def system_config_set(self, section: str, key: str, value: Any) -> Any: + """ + Set a value in the system configuration + + Source: ``admin.inc.php`` line 113. + PHP signature: ``system_config_set($session_id, $section, $key, $value)``. + + Params (from PHPDoc): + session (int): id + section (string): of the config field in the table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc + key (string): of the option that you want to set + option (string): value that you want to set + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("system_config_set", ("section", section), ("key", key), ("value", value)) + + def update_record_permissions( + self, tablename: Any, index_field: str, index_value: str, permissions: dict[str, Any] | list[Any] + ) -> Any: + """ + set record permissions in any table + + Source: ``admin.inc.php`` line 51. + PHP signature: ``update_record_permissions($session_id, $tablename, $index_field, $index_value, $permissions)``. + + Params (from PHPDoc): + index_field (string) + index_value (string) + permissions (array) + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "update_record_permissions", + ("tablename", tablename), + ("index_field", index_field), + ("index_value", index_value), + ("permissions", permissions), + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/aps.py b/src/ispconfig/aps.py new file mode 100644 index 0000000..875179a --- /dev/null +++ b/src/ispconfig/aps.py @@ -0,0 +1,154 @@ +"""``aps.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class ApsModule: + """Auto-generated module: Aps. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_aps_available_packages_list(self, params: Any = None) -> Any: + """ + Auto-generated wrapper for ``sites_aps_available_packages_list``. + + Source: ``aps.inc.php`` line 56. + PHP signature: ``sites_aps_available_packages_list($session_id, $params = array())``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_available_packages_list", ("params", params)) + + def sites_aps_change_package_status(self, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_aps_change_package_status``. + + Source: ``aps.inc.php`` line 201. + PHP signature: ``sites_aps_change_package_status($session_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_aps_change_package_status", ("primary_id", primary_id), ("params", params) + ) + + def sites_aps_get_package_details(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_aps_get_package_details``. + + Source: ``aps.inc.php`` line 78. + PHP signature: ``sites_aps_get_package_details($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_get_package_details", ("primary_id", primary_id)) + + def sites_aps_get_package_file(self, primary_id: Any, filename: Any) -> Any: + """ + Auto-generated wrapper for ``sites_aps_get_package_file``. + + Source: ``aps.inc.php`` line 118. + PHP signature: ``sites_aps_get_package_file($session_id, $primary_id, $filename)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_get_package_file", ("primary_id", primary_id), ("filename", filename)) + + def sites_aps_get_package_settings(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_aps_get_package_settings``. + + Source: ``aps.inc.php`` line 163. + PHP signature: ``sites_aps_get_package_settings($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_get_package_settings", ("primary_id", primary_id)) + + def sites_aps_install_package(self, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_aps_install_package``. + + Source: ``aps.inc.php`` line 231. + PHP signature: ``sites_aps_install_package($session_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_install_package", ("primary_id", primary_id), ("params", params)) + + def sites_aps_instance_delete(self, primary_id: Any, params: Any = None) -> Any: + """ + Auto-generated wrapper for ``sites_aps_instance_delete``. + + Source: ``aps.inc.php`` line 331. + PHP signature: ``sites_aps_instance_delete($session_id, $primary_id, $params = array())``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_instance_delete", ("primary_id", primary_id), ("params", params)) + + def sites_aps_instance_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_aps_instance_get``. + + Source: ``aps.inc.php`` line 303. + PHP signature: ``sites_aps_instance_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_instance_get", ("primary_id", primary_id)) + + def sites_aps_instance_settings_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_aps_instance_settings_get``. + + Source: ``aps.inc.php`` line 317. + PHP signature: ``sites_aps_instance_settings_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_instance_settings_get", ("primary_id", primary_id)) + + def sites_aps_update_package_list(self) -> Any: + """ + Auto-generated wrapper for ``sites_aps_update_package_list``. + + Source: ``aps.inc.php`` line 38. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_aps_update_package_list") + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/backups.py b/src/ispconfig/backups.py new file mode 100644 index 0000000..b7ed4e4 --- /dev/null +++ b/src/ispconfig/backups.py @@ -0,0 +1,59 @@ +"""``backups.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class BackupsModule: + """Auto-generated module: Backups. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_web_domain_backup(self, primary_id: Any, action_type: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_domain_backup``. + + Source: ``sites.inc.php`` line 926. + PHP signature: ``sites_web_domain_backup($session_id, $primary_id, $action_type)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_domain_backup", ("primary_id", primary_id), ("action_type", action_type) + ) + + def sites_web_domain_backup_list(self, site_id: Any = None) -> Any: + """ + Auto-generated wrapper for ``sites_web_domain_backup_list``. + + Source: ``sites.inc.php`` line 912. + PHP signature: ``sites_web_domain_backup_list($session_id, $site_id = null)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_domain_backup_list", ("site_id", site_id)) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/client.py b/src/ispconfig/client.py index 5dd6283..a5490f2 100644 --- a/src/ispconfig/client.py +++ b/src/ispconfig/client.py @@ -8,11 +8,23 @@ from typing import Any from . import exceptions as _exc from ._soap import SoapFault, SoapTransport +from .admin import AdminModule +from .aps import ApsModule +from .backups import BackupsModule from .clients import ClientsModule +from .cron import CronModule from .databases import DatabasesModule from .dns import DnsModule +from .domains import DomainsModule +from .ftp import FtpModule from .mail import MailModule +from .misc import MiscModule +from .monitor import MonitorModule +from .openvz import OpenvzModule +from .server import ServerModule +from .shell import ShellModule from .sites import SitesModule +from .webdav import WebdavModule log = logging.getLogger("ispconfig") @@ -48,11 +60,26 @@ class ISPConfigClient: self._transport = SoapTransport(url, verify_ssl=verify_ssl, timeout=timeout) self._session_id: str | None = None + # Hand-audited modules (stable API). self.sites = SitesModule(self) self.dns = DnsModule(self) self.mail = MailModule(self) self.databases = DatabasesModule(self) self.clients = ClientsModule(self) + # Auto-generated modules (full surface, param shapes not yet + # verified in prod use — see per-method docstrings). + self.admin = AdminModule(self) + self.aps = ApsModule(self) + self.backups = BackupsModule(self) + self.cron = CronModule(self) + self.domains = DomainsModule(self) + self.ftp = FtpModule(self) + self.misc = MiscModule(self) + self.monitor = MonitorModule(self) + self.openvz = OpenvzModule(self) + self.server = ServerModule(self) + self.shell = ShellModule(self) + self.webdav = WebdavModule(self) # ---- context manager --------------------------------------------- @@ -105,6 +132,38 @@ class ISPConfigClient: """Read-only accessor — exposed for debugging, not for API calls.""" return self._session_id + # ---- escape hatches ---------------------------------------------- + + def raw_call(self, method: str, *args: Any) -> Any: + """Invoke an arbitrary ISPConfig remote method by name. + + Use this when the SDK doesn't yet wrap the method you need — + newer ISPConfig versions may expose calls our inventory hasn't + caught up with. Args are passed positionally; names are cosmetic + on the wire, so we auto-number them as ``arg1``, ``arg2``, ... + + If the call fails, capture ``FaultError.faultcode`` / + ``FaultError.faultstring`` and file an issue against + ``Sulkta-Coop/ispconfig-py`` so we can add the method properly. + """ + named_args = tuple((f"arg{i + 1}", v) for i, v in enumerate(args)) + return self._call(method, *named_args) + + def list_functions(self) -> list[str]: + """Introspect the panel: return the list of remote methods it exposes. + + Wrapper for ISPConfig's own ``get_function_list``. Handy when + checking whether your panel version supports a given call before + attempting it via :meth:`raw_call`. + """ + result = self._call("get_function_list") + if isinstance(result, list): + return [str(x) for x in result] + if isinstance(result, dict): + # Some versions return a map keyed by integer index. + return [str(v) for v in result.values()] + return [] + # ---- the hot path ------------------------------------------------ def _call(self, method: str, *args: tuple[str, Any]) -> Any: diff --git a/src/ispconfig/clients.py b/src/ispconfig/clients.py index dc6fe4c..6585d53 100644 --- a/src/ispconfig/clients.py +++ b/src/ispconfig/clients.py @@ -11,7 +11,7 @@ ISPConfig's client model has two IDs you'll trip over: from __future__ import annotations -from typing import TYPE_CHECKING, cast +from typing import TYPE_CHECKING, Any, cast from .types import Client @@ -23,6 +23,284 @@ class ClientsModule: def __init__(self, client: ISPConfigClient) -> None: self._c = client + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def client_add(self, reseller_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``client_add``. + + Source: ``client.inc.php`` line 157. + PHP signature: ``client_add($session_id, $reseller_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_add", ("reseller_id", reseller_id), ("params", params)) + + def client_change_password(self, client_id: Any, new_password: Any) -> Any: + """ + Changes client password + + Source: ``client.inc.php`` line 537. + PHP signature: ``client_change_password($session_id, $client_id, $new_password)``. + + Params (from PHPDoc): + session (int): id + client (int): id + new (string): password + + Returns: bool - true if success + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "client_change_password", ("client_id", client_id), ("new_password", new_password) + ) + + def client_delete(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_delete``. + + Source: ``client.inc.php`` line 372. + PHP signature: ``client_delete($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_delete", ("client_id", client_id)) + + def client_delete_everything(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_delete_everything``. + + Source: ``client.inc.php`` line 390. + PHP signature: ``client_delete_everything($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_delete_everything", ("client_id", client_id)) + + def client_get(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_get``. + + Source: ``client.inc.php`` line 51. + PHP signature: ``client_get($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get", ("client_id", client_id)) + + def client_get_all(self) -> Any: + """ + Get All client_id's from database + + Source: ``client.inc.php`` line 512. + + Params (from PHPDoc): + + Returns: Array - of all client_id's + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get_all") + + def client_get_by_customer_no(self, customer_no: Any) -> Any: + """ + Auto-generated wrapper for ``client_get_by_customer_no``. + + Source: ``client.inc.php`` line 485. + PHP signature: ``client_get_by_customer_no($session_id, $customer_no)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get_by_customer_no", ("customer_no", customer_no)) + + def client_get_by_groupid(self, group_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_get_by_groupid``. + + Source: ``client.inc.php`` line 688. + PHP signature: ``client_get_by_groupid($session_id, $group_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get_by_groupid", ("group_id", group_id)) + + def client_get_by_username(self, username: Any) -> Any: + """ + Get sys_user information by username + + Source: ``client.inc.php`` line 469. + PHP signature: ``client_get_by_username($session_id, $username)``. + + Params (from PHPDoc): + session (int): id + user (string): 's name + + Returns: mixed - false if error + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get_by_username", ("username", username)) + + def client_get_emailcontact(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_get_emailcontact``. + + Source: ``client.inc.php`` line 118. + PHP signature: ``client_get_emailcontact($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get_emailcontact", ("client_id", client_id)) + + def client_get_groupid(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_get_groupid``. + + Source: ``client.inc.php`` line 137. + PHP signature: ``client_get_groupid($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get_groupid", ("client_id", client_id)) + + def client_get_id(self, sys_userid: Any) -> Any: + """ + Auto-generated wrapper for ``client_get_id``. + + Source: ``client.inc.php`` line 96. + PHP signature: ``client_get_id($session_id, $sys_userid)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_get_id", ("sys_userid", sys_userid)) + + def client_get_sites_by_user(self, sys_userid: Any, sys_groupid: Any) -> Any: + """ + Gets sites by $sys_userid & $sys_groupid + + Source: ``sites.inc.php`` line 835. + PHP signature: ``client_get_sites_by_user($session_id, $sys_userid, $sys_groupid)``. + + Params (from PHPDoc): + session (int): id + user (int): id + list (array): of groups + + Returns: mixed - array with sites by user + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "client_get_sites_by_user", ("sys_userid", sys_userid), ("sys_groupid", sys_groupid) + ) + + def client_login_get(self, username: Any, password: Any, remote_ip: Any = "") -> Any: + """ + Auto-generated wrapper for ``client_login_get``. + + Source: ``client.inc.php`` line 576. + PHP signature: ``client_login_get($session_id,$username,$password,$remote_ip = '')``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "client_login_get", ("username", username), ("password", password), ("remote_ip", remote_ip) + ) + + def client_template_additional_add(self, client_id: Any, template_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_template_additional_add``. + + Source: ``client.inc.php`` line 296. + PHP signature: ``client_template_additional_add($session_id, $client_id, $template_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "client_template_additional_add", ("client_id", client_id), ("template_id", template_id) + ) + + def client_template_additional_delete(self, client_id: Any, assigned_template_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_template_additional_delete``. + + Source: ``client.inc.php`` line 334. + PHP signature: ``client_template_additional_delete($session_id, $client_id, $assigned_template_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "client_template_additional_delete", + ("client_id", client_id), + ("assigned_template_id", assigned_template_id), + ) + + def client_template_additional_get(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``client_template_additional_get``. + + Source: ``client.inc.php`` line 258. + PHP signature: ``client_template_additional_get($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_template_additional_get", ("client_id", client_id)) + + def client_templates_get_all(self) -> Any: + """ + Get all client templates + + Source: ``client.inc.php`` line 566. + + Params (from PHPDoc): + session (int): id + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("client_templates_get_all") + + def client_update(self, client_id: Any, reseller_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``client_update``. + + Source: ``client.inc.php`` line 187. + PHP signature: ``client_update($session_id, $client_id, $reseller_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "client_update", ("client_id", client_id), ("reseller_id", reseller_id), ("params", params) + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + def get(self, primary_id: int) -> Client: return cast(Client, self._c._call("client_get", ("primary_id", int(primary_id)))) diff --git a/src/ispconfig/cron.py b/src/ispconfig/cron.py new file mode 100644 index 0000000..9096a06 --- /dev/null +++ b/src/ispconfig/cron.py @@ -0,0 +1,83 @@ +"""``cron.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class CronModule: + """Auto-generated module: Cron. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_cron_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_cron_add``. + + Source: ``sites.inc.php`` line 59. + PHP signature: ``sites_cron_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_cron_add", ("client_id", client_id), ("params", params)) + + def sites_cron_delete(self, cron_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_cron_delete``. + + Source: ``sites.inc.php`` line 80. + PHP signature: ``sites_cron_delete($session_id, $cron_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_cron_delete", ("cron_id", cron_id)) + + def sites_cron_get(self, cron_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_cron_get``. + + Source: ``sites.inc.php`` line 45. + PHP signature: ``sites_cron_get($session_id, $cron_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_cron_get", ("cron_id", cron_id)) + + def sites_cron_update(self, client_id: Any, cron_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_cron_update``. + + Source: ``sites.inc.php`` line 69. + PHP signature: ``sites_cron_update($session_id, $client_id, $cron_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_cron_update", ("client_id", client_id), ("cron_id", cron_id), ("params", params) + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/databases.py b/src/ispconfig/databases.py index 2797cff..4164552 100644 --- a/src/ispconfig/databases.py +++ b/src/ispconfig/databases.py @@ -20,6 +20,132 @@ class DatabasesModule: def __init__(self, client: ISPConfigClient) -> None: self._c = client + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_database_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_add``. + + Source: ``sites.inc.php`` line 108. + PHP signature: ``sites_database_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_database_add", ("client_id", client_id), ("params", params)) + + def sites_database_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_delete``. + + Source: ``sites.inc.php`` line 185. + PHP signature: ``sites_database_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_database_delete", ("primary_id", primary_id)) + + def sites_database_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_get``. + + Source: ``sites.inc.php`` line 93. + PHP signature: ``sites_database_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_database_get", ("primary_id", primary_id)) + + def sites_database_get_all_by_user(self, client_id: Any) -> Any: + """ + Get all databases by user + + Source: ``sites.inc.php`` line 898. + PHP signature: ``sites_database_get_all_by_user($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_database_get_all_by_user", ("client_id", client_id)) + + def sites_database_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_update``. + + Source: ``sites.inc.php`` line 151. + PHP signature: ``sites_database_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_database_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def sites_database_user_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_user_add``. + + Source: ``sites.inc.php`` line 217. + PHP signature: ``sites_database_user_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_database_user_add", ("client_id", client_id), ("params", params)) + + def sites_database_user_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_user_delete``. + + Source: ``sites.inc.php`` line 258. + PHP signature: ``sites_database_user_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_database_user_delete", ("primary_id", primary_id)) + + def sites_database_user_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_user_get``. + + Source: ``sites.inc.php`` line 203. + PHP signature: ``sites_database_user_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_database_user_get", ("primary_id", primary_id)) + + def sites_database_user_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_database_user_update``. + + Source: ``sites.inc.php`` line 228. + PHP signature: ``sites_database_user_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_database_user_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + def get(self, primary_id: int) -> Database: return self._c.sites.database_get(primary_id) diff --git a/src/ispconfig/dns.py b/src/ispconfig/dns.py index 3a01d8c..5d2cffe 100644 --- a/src/ispconfig/dns.py +++ b/src/ispconfig/dns.py @@ -31,6 +31,1267 @@ class DnsModule: def __init__(self, client: ISPConfigClient) -> None: self._c = client + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def dns_a_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_a_add``. + + Source: ``dns.inc.php`` line 292. + PHP signature: ``dns_a_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_a_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_a_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_a_delete``. + + Source: ``dns.inc.php`` line 302. + PHP signature: ``dns_a_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_a_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_a_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_a_get``. + + Source: ``dns.inc.php`` line 287. + PHP signature: ``dns_a_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_a_get", ("primary_id", primary_id)) + + def dns_a_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_a_update``. + + Source: ``dns.inc.php`` line 297. + PHP signature: ``dns_a_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_a_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_aaaa_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_aaaa_add``. + + Source: ``dns.inc.php`` line 270. + PHP signature: ``dns_aaaa_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_aaaa_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_aaaa_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_aaaa_delete``. + + Source: ``dns.inc.php`` line 280. + PHP signature: ``dns_aaaa_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_aaaa_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_aaaa_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_aaaa_get``. + + Source: ``dns.inc.php`` line 265. + PHP signature: ``dns_aaaa_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_aaaa_get", ("primary_id", primary_id)) + + def dns_aaaa_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_aaaa_update``. + + Source: ``dns.inc.php`` line 275. + PHP signature: ``dns_aaaa_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_aaaa_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_alias_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_alias_add``. + + Source: ``dns.inc.php`` line 314. + PHP signature: ``dns_alias_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_alias_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_alias_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_alias_delete``. + + Source: ``dns.inc.php`` line 324. + PHP signature: ``dns_alias_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_alias_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_alias_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_alias_get``. + + Source: ``dns.inc.php`` line 309. + PHP signature: ``dns_alias_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_alias_get", ("primary_id", primary_id)) + + def dns_alias_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_alias_update``. + + Source: ``dns.inc.php`` line 319. + PHP signature: ``dns_alias_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_alias_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_caa_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_caa_add``. + + Source: ``dns.inc.php`` line 336. + PHP signature: ``dns_caa_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_caa_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_caa_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_caa_delete``. + + Source: ``dns.inc.php`` line 346. + PHP signature: ``dns_caa_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_caa_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_caa_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_caa_get``. + + Source: ``dns.inc.php`` line 331. + PHP signature: ``dns_caa_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_caa_get", ("primary_id", primary_id)) + + def dns_caa_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_caa_update``. + + Source: ``dns.inc.php`` line 341. + PHP signature: ``dns_caa_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_caa_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_cname_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_cname_add``. + + Source: ``dns.inc.php`` line 358. + PHP signature: ``dns_cname_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_cname_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_cname_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_cname_delete``. + + Source: ``dns.inc.php`` line 368. + PHP signature: ``dns_cname_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_cname_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_cname_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_cname_get``. + + Source: ``dns.inc.php`` line 353. + PHP signature: ``dns_cname_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_cname_get", ("primary_id", primary_id)) + + def dns_cname_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_cname_update``. + + Source: ``dns.inc.php`` line 363. + PHP signature: ``dns_cname_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_cname_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_dname_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_dname_add``. + + Source: ``dns.inc.php`` line 380. + PHP signature: ``dns_dname_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_dname_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_dname_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_dname_delete``. + + Source: ``dns.inc.php`` line 390. + PHP signature: ``dns_dname_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_dname_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_dname_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_dname_get``. + + Source: ``dns.inc.php`` line 375. + PHP signature: ``dns_dname_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_dname_get", ("primary_id", primary_id)) + + def dns_dname_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_dname_update``. + + Source: ``dns.inc.php`` line 385. + PHP signature: ``dns_dname_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_dname_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_ds_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ds_add``. + + Source: ``dns.inc.php`` line 513. + PHP signature: ``dns_ds_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_ds_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_ds_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ds_delete``. + + Source: ``dns.inc.php`` line 523. + PHP signature: ``dns_ds_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_ds_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_ds_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_ds_get``. + + Source: ``dns.inc.php`` line 508. + PHP signature: ``dns_ds_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_ds_get", ("primary_id", primary_id)) + + def dns_ds_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ds_update``. + + Source: ``dns.inc.php`` line 518. + PHP signature: ``dns_ds_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_ds_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_hinfo_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_hinfo_add``. + + Source: ``dns.inc.php`` line 402. + PHP signature: ``dns_hinfo_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_hinfo_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_hinfo_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_hinfo_delete``. + + Source: ``dns.inc.php`` line 412. + PHP signature: ``dns_hinfo_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_hinfo_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_hinfo_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_hinfo_get``. + + Source: ``dns.inc.php`` line 397. + PHP signature: ``dns_hinfo_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_hinfo_get", ("primary_id", primary_id)) + + def dns_hinfo_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_hinfo_update``. + + Source: ``dns.inc.php`` line 407. + PHP signature: ``dns_hinfo_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_hinfo_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_loc_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_loc_add``. + + Source: ``dns.inc.php`` line 425. + PHP signature: ``dns_loc_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_loc_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_loc_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_loc_delete``. + + Source: ``dns.inc.php`` line 435. + PHP signature: ``dns_loc_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_loc_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_loc_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_loc_get``. + + Source: ``dns.inc.php`` line 420. + PHP signature: ``dns_loc_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_loc_get", ("primary_id", primary_id)) + + def dns_loc_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_loc_update``. + + Source: ``dns.inc.php`` line 430. + PHP signature: ``dns_loc_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_loc_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_mx_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_mx_add``. + + Source: ``dns.inc.php`` line 447. + PHP signature: ``dns_mx_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_mx_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_mx_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_mx_delete``. + + Source: ``dns.inc.php`` line 457. + PHP signature: ``dns_mx_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_mx_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_mx_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_mx_get``. + + Source: ``dns.inc.php`` line 442. + PHP signature: ``dns_mx_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_mx_get", ("primary_id", primary_id)) + + def dns_mx_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_mx_update``. + + Source: ``dns.inc.php`` line 452. + PHP signature: ``dns_mx_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_mx_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_naptr_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_naptr_add``. + + Source: ``dns.inc.php`` line 469. + PHP signature: ``dns_naptr_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_naptr_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_naptr_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_naptr_delete``. + + Source: ``dns.inc.php`` line 479. + PHP signature: ``dns_naptr_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_naptr_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_naptr_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_naptr_get``. + + Source: ``dns.inc.php`` line 464. + PHP signature: ``dns_naptr_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_naptr_get", ("primary_id", primary_id)) + + def dns_naptr_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_naptr_update``. + + Source: ``dns.inc.php`` line 474. + PHP signature: ``dns_naptr_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_naptr_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_ns_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ns_add``. + + Source: ``dns.inc.php`` line 491. + PHP signature: ``dns_ns_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_ns_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_ns_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ns_delete``. + + Source: ``dns.inc.php`` line 501. + PHP signature: ``dns_ns_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_ns_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_ns_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_ns_get``. + + Source: ``dns.inc.php`` line 486. + PHP signature: ``dns_ns_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_ns_get", ("primary_id", primary_id)) + + def dns_ns_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ns_update``. + + Source: ``dns.inc.php`` line 496. + PHP signature: ``dns_ns_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_ns_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_ptr_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ptr_add``. + + Source: ``dns.inc.php`` line 535. + PHP signature: ``dns_ptr_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_ptr_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_ptr_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ptr_delete``. + + Source: ``dns.inc.php`` line 545. + PHP signature: ``dns_ptr_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_ptr_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_ptr_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_ptr_get``. + + Source: ``dns.inc.php`` line 530. + PHP signature: ``dns_ptr_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_ptr_get", ("primary_id", primary_id)) + + def dns_ptr_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_ptr_update``. + + Source: ``dns.inc.php`` line 540. + PHP signature: ``dns_ptr_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_ptr_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_rp_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_rp_add``. + + Source: ``dns.inc.php`` line 557. + PHP signature: ``dns_rp_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_rp_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_rp_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_rp_delete``. + + Source: ``dns.inc.php`` line 567. + PHP signature: ``dns_rp_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_rp_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_rp_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_rp_get``. + + Source: ``dns.inc.php`` line 552. + PHP signature: ``dns_rp_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_rp_get", ("primary_id", primary_id)) + + def dns_rp_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_rp_update``. + + Source: ``dns.inc.php`` line 562. + PHP signature: ``dns_rp_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_rp_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_rr_get_all_by_zone(self, zone_id: Any) -> Any: + """ + Get all dns records for a zone + + Source: ``dns.inc.php`` line 707. + PHP signature: ``dns_rr_get_all_by_zone($session_id, $zone_id)``. + + Params (from PHPDoc): + session (int): id + dns (int): zone id + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_rr_get_all_by_zone", ("zone_id", zone_id)) + + def dns_slave_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``dns_slave_add``. + + Source: ``dns.inc.php`` line 114. + PHP signature: ``dns_slave_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_slave_add", ("client_id", client_id), ("params", params)) + + def dns_slave_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_slave_delete``. + + Source: ``dns.inc.php`` line 133. + PHP signature: ``dns_slave_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_slave_delete", ("primary_id", primary_id)) + + def dns_slave_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_slave_get``. + + Source: ``dns.inc.php`` line 100. + PHP signature: ``dns_slave_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_slave_get", ("primary_id", primary_id)) + + def dns_slave_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``dns_slave_update``. + + Source: ``dns.inc.php`` line 123. + PHP signature: ``dns_slave_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_slave_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def dns_srv_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_srv_add``. + + Source: ``dns.inc.php`` line 579. + PHP signature: ``dns_srv_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_srv_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_srv_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_srv_delete``. + + Source: ``dns.inc.php`` line 589. + PHP signature: ``dns_srv_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_srv_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_srv_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_srv_get``. + + Source: ``dns.inc.php`` line 574. + PHP signature: ``dns_srv_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_srv_get", ("primary_id", primary_id)) + + def dns_srv_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_srv_update``. + + Source: ``dns.inc.php`` line 584. + PHP signature: ``dns_srv_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_srv_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_sshfp_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_sshfp_add``. + + Source: ``dns.inc.php`` line 601. + PHP signature: ``dns_sshfp_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_sshfp_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_sshfp_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_sshfp_delete``. + + Source: ``dns.inc.php`` line 611. + PHP signature: ``dns_sshfp_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_sshfp_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_sshfp_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_sshfp_get``. + + Source: ``dns.inc.php`` line 596. + PHP signature: ``dns_sshfp_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_sshfp_get", ("primary_id", primary_id)) + + def dns_sshfp_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_sshfp_update``. + + Source: ``dns.inc.php`` line 606. + PHP signature: ``dns_sshfp_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_sshfp_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_templatezone_add( + self, + client_id: Any, + template_id: Any, + domain: Any, + ip: Any, + ns1: Any, + ns2: Any, + email: Any, + ipv6: Any = "", + ) -> Any: + """ + Auto-generated wrapper for ``dns_templatezone_add``. + + Source: ``dns.inc.php`` line 45. + PHP signature: ``dns_templatezone_add($session_id, $client_id, $template_id, $domain, $ip, $ns1, $ns2, $email, $ipv6 = '')``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_templatezone_add", + ("client_id", client_id), + ("template_id", template_id), + ("domain", domain), + ("ip", ip), + ("ns1", ns1), + ("ns2", ns2), + ("email", email), + ("ipv6", ipv6), + ) + + def dns_templatezone_get_all(self) -> Any: + """ + Auto-generated wrapper for ``dns_templatezone_get_all``. + + Source: ``dns.inc.php`` line 684. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_templatezone_get_all") + + def dns_tlsa_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_tlsa_add``. + + Source: ``dns.inc.php`` line 623. + PHP signature: ``dns_tlsa_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_tlsa_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_tlsa_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_tlsa_delete``. + + Source: ``dns.inc.php`` line 633. + PHP signature: ``dns_tlsa_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_tlsa_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_tlsa_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_tlsa_get``. + + Source: ``dns.inc.php`` line 618. + PHP signature: ``dns_tlsa_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_tlsa_get", ("primary_id", primary_id)) + + def dns_tlsa_update( + self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False + ) -> Any: + """ + Auto-generated wrapper for ``dns_tlsa_update``. + + Source: ``dns.inc.php`` line 628. + PHP signature: ``dns_tlsa_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_tlsa_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_txt_add(self, client_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_txt_add``. + + Source: ``dns.inc.php`` line 645. + PHP signature: ``dns_txt_add($session_id, $client_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_txt_add", ("client_id", client_id), ("params", params), ("update_serial", update_serial) + ) + + def dns_txt_delete(self, primary_id: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_txt_delete``. + + Source: ``dns.inc.php`` line 655. + PHP signature: ``dns_txt_delete($session_id, $primary_id, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_txt_delete", ("primary_id", primary_id), ("update_serial", update_serial)) + + def dns_txt_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_txt_get``. + + Source: ``dns.inc.php`` line 640. + PHP signature: ``dns_txt_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_txt_get", ("primary_id", primary_id)) + + def dns_txt_update(self, client_id: Any, primary_id: Any, params: Any, update_serial: Any = False) -> Any: + """ + Auto-generated wrapper for ``dns_txt_update``. + + Source: ``dns.inc.php`` line 650. + PHP signature: ``dns_txt_update($session_id, $client_id, $primary_id, $params, $update_serial=false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_txt_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ("update_serial", update_serial), + ) + + def dns_zone_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``dns_zone_add``. + + Source: ``dns.inc.php`` line 165. + PHP signature: ``dns_zone_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_zone_add", ("client_id", client_id), ("params", params)) + + def dns_zone_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_zone_delete``. + + Source: ``dns.inc.php`` line 184. + PHP signature: ``dns_zone_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_zone_delete", ("primary_id", primary_id)) + + def dns_zone_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``dns_zone_get``. + + Source: ``dns.inc.php`` line 87. + PHP signature: ``dns_zone_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_zone_get", ("primary_id", primary_id)) + + def dns_zone_get_by_user(self, client_id: Any, server_id: Any) -> Any: + """ + Get all DNS zone by user + + Source: ``dns.inc.php`` line 663. + PHP signature: ``dns_zone_get_by_user($session_id, $client_id, $server_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_zone_get_by_user", ("client_id", client_id), ("server_id", server_id)) + + def dns_zone_get_id(self, origin: Any) -> Any: + """ + Auto-generated wrapper for ``dns_zone_get_id``. + + Source: ``dns.inc.php`` line 142. + PHP signature: ``dns_zone_get_id($session_id, $origin)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_zone_get_id", ("origin", origin)) + + def dns_zone_set_dnssec( + self, client_id: Any, primary_id: Any, algo: Any, update_serial: Any = False + ) -> Any: + """ + Set DNSSec Algo and activate it if needed. + + Source: ``dns.inc.php`` line 757. + PHP signature: ``dns_zone_set_dnssec($session_id, $client_id, $primary_id, $algo, $update_serial=false)``. + + Params (from PHPDoc): + session (int): id + client (int): id + algorithm (string): 'NSEC3RSASHA1', 'ECDSAP256SHA256' or 'NSEC3RSASHA1,ECDSAP256SHA256' string + update (boolean): serial + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_zone_set_dnssec", + ("client_id", client_id), + ("primary_id", primary_id), + ("algo", algo), + ("update_serial", update_serial), + ) + + def dns_zone_set_status(self, primary_id: Any, status: str) -> Any: + """ + Changes DNS zone status + + Source: ``dns.inc.php`` line 725. + PHP signature: ``dns_zone_set_status($session_id, $primary_id, $status)``. + + Params (from PHPDoc): + session (int): id + dns (int): soa id + status (string): active or inactive string + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("dns_zone_set_status", ("primary_id", primary_id), ("status", status)) + + def dns_zone_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``dns_zone_update``. + + Source: ``dns.inc.php`` line 174. + PHP signature: ``dns_zone_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "dns_zone_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + # ---- zones -------------------------------------------------------- def zone_get(self, primary_id: int) -> DnsZone: @@ -63,19 +1324,23 @@ class DnsModule: return int(result) if result else 0 def zone_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "dns_zone_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "dns_zone_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def zone_update(self, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "dns_zone_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "dns_zone_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) def zone_delete(self, primary_id: int) -> int: return int(self._c._call("dns_zone_delete", ("primary_id", int(primary_id)))) @@ -93,11 +1358,13 @@ class DnsModule: up with a ``dns_rr_update`` that writes ``type='A'``. No-op on fixed versions, harmless. """ - rr_id = int(self._c._call( - "dns_a_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + rr_id = int( + self._c._call( + "dns_a_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) if fix_type_bug and rr_id: try: self._c._call( @@ -111,36 +1378,44 @@ class DnsModule: return rr_id def a_update(self, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "dns_a_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "dns_a_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) def a_delete(self, primary_id: int) -> int: return int(self._c._call("dns_a_delete", ("primary_id", int(primary_id)))) def cname_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "dns_cname_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "dns_cname_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def mx_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "dns_mx_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "dns_mx_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def txt_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "dns_txt_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "dns_txt_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def rr_get(self, method_prefix: str, primary_id: int) -> DnsRr: """Generic ``dns_{type}_get`` — e.g. ``rr_get('cname', 42)``.""" @@ -148,12 +1423,14 @@ class DnsModule: def rr_update(self, type_: str, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: """Generic ``dns_{type}_update``. ``type_`` is ``a``, ``cname``, etc.""" - return int(self._c._call( - f"dns_{type_}_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + f"dns_{type_}_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) def rr_delete(self, type_: str, primary_id: int) -> int: return int(self._c._call(f"dns_{type_}_delete", ("primary_id", int(primary_id)))) diff --git a/src/ispconfig/domains.py b/src/ispconfig/domains.py new file mode 100644 index 0000000..9844efe --- /dev/null +++ b/src/ispconfig/domains.py @@ -0,0 +1,95 @@ +"""``domains.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class DomainsModule: + """Auto-generated module: Domains. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def domains_domain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``domains_domain_add``. + + Source: ``domains.inc.php`` line 59. + PHP signature: ``domains_domain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("domains_domain_add", ("client_id", client_id), ("params", params)) + + def domains_domain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``domains_domain_delete``. + + Source: ``domains.inc.php`` line 79. + PHP signature: ``domains_domain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("domains_domain_delete", ("primary_id", primary_id)) + + def domains_domain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``domains_domain_get``. + + Source: ``domains.inc.php`` line 45. + PHP signature: ``domains_domain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("domains_domain_get", ("primary_id", primary_id)) + + def domains_domain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``domains_domain_update``. + + Source: ``domains.inc.php`` line 69. + PHP signature: ``domains_domain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "domains_domain_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def domains_get_all_by_user(self, group_id: Any) -> Any: + """ + Auto-generated wrapper for ``domains_get_all_by_user``. + + Source: ``domains.inc.php`` line 90. + PHP signature: ``domains_get_all_by_user($session_id, $group_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("domains_get_all_by_user", ("group_id", group_id)) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/exceptions.py b/src/ispconfig/exceptions.py index dbae0b1..e6ee011 100644 --- a/src/ispconfig/exceptions.py +++ b/src/ispconfig/exceptions.py @@ -47,11 +47,14 @@ def map_fault(faultcode: str, faultstring: str) -> ISPConfigError: return AuthError(faultstring) if "permission denied" in msg or "you do not have the permissions" in msg or "not allowed" in msg: return PermissionError(faultstring) + code_low = faultcode.lower() if ( "no records found" in msg or "not found" in msg or "no record found" in msg - or "no_domain_found" in faultcode.lower() + or "no_domain_found" in code_low + or "no_client_found" in code_low + or "no user account" in msg or "invalid domain name" in msg ): return NotFoundError(faultstring) diff --git a/src/ispconfig/ftp.py b/src/ispconfig/ftp.py new file mode 100644 index 0000000..873482a --- /dev/null +++ b/src/ispconfig/ftp.py @@ -0,0 +1,95 @@ +"""``ftp.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class FtpModule: + """Auto-generated module: Ftp. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_ftp_user_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_ftp_user_add``. + + Source: ``sites.inc.php`` line 300. + PHP signature: ``sites_ftp_user_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_ftp_user_add", ("client_id", client_id), ("params", params)) + + def sites_ftp_user_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_ftp_user_delete``. + + Source: ``sites.inc.php`` line 321. + PHP signature: ``sites_ftp_user_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_ftp_user_delete", ("primary_id", primary_id)) + + def sites_ftp_user_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_ftp_user_get``. + + Source: ``sites.inc.php`` line 286. + PHP signature: ``sites_ftp_user_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_ftp_user_get", ("primary_id", primary_id)) + + def sites_ftp_user_server_get(self, ftp_user: Any) -> Any: + """ + Auto-generated wrapper for ``sites_ftp_user_server_get``. + + Source: ``sites.inc.php`` line 332. + PHP signature: ``sites_ftp_user_server_get($session_id, $ftp_user)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_ftp_user_server_get", ("ftp_user", ftp_user)) + + def sites_ftp_user_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_ftp_user_update``. + + Source: ``sites.inc.php`` line 310. + PHP signature: ``sites_ftp_user_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_ftp_user_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/mail.py b/src/ispconfig/mail.py index 77bcb4c..6d7865d 100644 --- a/src/ispconfig/mail.py +++ b/src/ispconfig/mail.py @@ -24,6 +24,1068 @@ class MailModule: def __init__(self, client: ISPConfigClient) -> None: self._c = client + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def mail_alias_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_alias_add``. + + Source: ``mail.inc.php`` line 424. + PHP signature: ``mail_alias_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_alias_add", ("client_id", client_id), ("params", params)) + + def mail_alias_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_alias_delete``. + + Source: ``mail.inc.php`` line 466. + PHP signature: ``mail_alias_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_alias_delete", ("primary_id", primary_id)) + + def mail_alias_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_alias_get``. + + Source: ``mail.inc.php`` line 410. + PHP signature: ``mail_alias_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_alias_get", ("primary_id", primary_id)) + + def mail_alias_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_alias_update``. + + Source: ``mail.inc.php`` line 444. + PHP signature: ``mail_alias_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_alias_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_aliasdomain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_aliasdomain_add``. + + Source: ``mail.inc.php`` line 111. + PHP signature: ``mail_aliasdomain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_aliasdomain_add", ("client_id", client_id), ("params", params)) + + def mail_aliasdomain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_aliasdomain_delete``. + + Source: ``mail.inc.php`` line 133. + PHP signature: ``mail_aliasdomain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_aliasdomain_delete", ("primary_id", primary_id)) + + def mail_aliasdomain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_aliasdomain_get``. + + Source: ``mail.inc.php`` line 97. + PHP signature: ``mail_aliasdomain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_aliasdomain_get", ("primary_id", primary_id)) + + def mail_aliasdomain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_aliasdomain_update``. + + Source: ``mail.inc.php`` line 121. + PHP signature: ``mail_aliasdomain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_aliasdomain_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_blacklist_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_blacklist_add``. + + Source: ``mail.inc.php`` line 1040. + PHP signature: ``mail_blacklist_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_blacklist_add", ("client_id", client_id), ("params", params)) + + def mail_blacklist_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_blacklist_delete``. + + Source: ``mail.inc.php`` line 1062. + PHP signature: ``mail_blacklist_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_blacklist_delete", ("primary_id", primary_id)) + + def mail_blacklist_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_blacklist_get``. + + Source: ``mail.inc.php`` line 1026. + PHP signature: ``mail_blacklist_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_blacklist_get", ("primary_id", primary_id)) + + def mail_blacklist_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_blacklist_update``. + + Source: ``mail.inc.php`` line 1050. + PHP signature: ``mail_blacklist_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_blacklist_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_catchall_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_catchall_add``. + + Source: ``mail.inc.php`` line 543. + PHP signature: ``mail_catchall_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_catchall_add", ("client_id", client_id), ("params", params)) + + def mail_catchall_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_catchall_delete``. + + Source: ``mail.inc.php`` line 564. + PHP signature: ``mail_catchall_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_catchall_delete", ("primary_id", primary_id)) + + def mail_catchall_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_catchall_get``. + + Source: ``mail.inc.php`` line 529. + PHP signature: ``mail_catchall_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_catchall_get", ("primary_id", primary_id)) + + def mail_catchall_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_catchall_update``. + + Source: ``mail.inc.php`` line 553. + PHP signature: ``mail_catchall_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_catchall_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_domain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_domain_add``. + + Source: ``mail.inc.php`` line 57. + PHP signature: ``mail_domain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_domain_add", ("client_id", client_id), ("params", params)) + + def mail_domain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_domain_delete``. + + Source: ``mail.inc.php`` line 86. + PHP signature: ``mail_domain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_domain_delete", ("primary_id", primary_id)) + + def mail_domain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_domain_get``. + + Source: ``mail.inc.php`` line 43. + PHP signature: ``mail_domain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_domain_get", ("primary_id", primary_id)) + + def mail_domain_get_by_domain(self, domain: Any) -> Any: + """ + Fetch the mail_domain record for the provided domain. + + Source: ``mail.inc.php`` line 1132. + PHP signature: ``mail_domain_get_by_domain($session_id, $domain)``. + + Params (from PHPDoc): + the (string): fully qualified domain (or subdomain) + + Returns: array - array of arrays corresponding to the mail_domain table's records + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_domain_get_by_domain", ("domain", domain)) + + def mail_domain_set_status(self, primary_id: Any, status: Any) -> Any: + """ + Auto-generated wrapper for ``mail_domain_set_status``. + + Source: ``mail.inc.php`` line 1147. + PHP signature: ``mail_domain_set_status($session_id, $primary_id, $status)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_domain_set_status", ("primary_id", primary_id), ("status", status)) + + def mail_domain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_domain_update``. + + Source: ``mail.inc.php`` line 75. + PHP signature: ``mail_domain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_domain_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_fetchmail_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_fetchmail_add``. + + Source: ``mail.inc.php`` line 940. + PHP signature: ``mail_fetchmail_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_fetchmail_add", ("client_id", client_id), ("params", params)) + + def mail_fetchmail_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_fetchmail_delete``. + + Source: ``mail.inc.php`` line 962. + PHP signature: ``mail_fetchmail_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_fetchmail_delete", ("primary_id", primary_id)) + + def mail_fetchmail_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_fetchmail_get``. + + Source: ``mail.inc.php`` line 926. + PHP signature: ``mail_fetchmail_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_fetchmail_get", ("primary_id", primary_id)) + + def mail_fetchmail_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_fetchmail_update``. + + Source: ``mail.inc.php`` line 950. + PHP signature: ``mail_fetchmail_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_fetchmail_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_filter_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_filter_add``. + + Source: ``mail.inc.php`` line 1090. + PHP signature: ``mail_filter_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_filter_add", ("client_id", client_id), ("params", params)) + + def mail_filter_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_filter_delete``. + + Source: ``mail.inc.php`` line 1112. + PHP signature: ``mail_filter_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_filter_delete", ("primary_id", primary_id)) + + def mail_filter_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_filter_get``. + + Source: ``mail.inc.php`` line 1076. + PHP signature: ``mail_filter_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_filter_get", ("primary_id", primary_id)) + + def mail_filter_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_filter_update``. + + Source: ``mail.inc.php`` line 1100. + PHP signature: ``mail_filter_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_filter_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_forward_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_forward_add``. + + Source: ``mail.inc.php`` line 493. + PHP signature: ``mail_forward_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_forward_add", ("client_id", client_id), ("params", params)) + + def mail_forward_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_forward_delete``. + + Source: ``mail.inc.php`` line 515. + PHP signature: ``mail_forward_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_forward_delete", ("primary_id", primary_id)) + + def mail_forward_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_forward_get``. + + Source: ``mail.inc.php`` line 479. + PHP signature: ``mail_forward_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_forward_get", ("primary_id", primary_id)) + + def mail_forward_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_forward_update``. + + Source: ``mail.inc.php`` line 503. + PHP signature: ``mail_forward_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_forward_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_mailinglist_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_mailinglist_add``. + + Source: ``mail.inc.php`` line 160. + PHP signature: ``mail_mailinglist_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_mailinglist_add", ("client_id", client_id), ("params", params)) + + def mail_mailinglist_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_mailinglist_delete``. + + Source: ``mail.inc.php`` line 182. + PHP signature: ``mail_mailinglist_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_mailinglist_delete", ("primary_id", primary_id)) + + def mail_mailinglist_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_mailinglist_get``. + + Source: ``mail.inc.php`` line 146. + PHP signature: ``mail_mailinglist_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_mailinglist_get", ("primary_id", primary_id)) + + def mail_mailinglist_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_mailinglist_update``. + + Source: ``mail.inc.php`` line 171. + PHP signature: ``mail_mailinglist_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_mailinglist_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_policy_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_policy_add``. + + Source: ``mail.inc.php`` line 890. + PHP signature: ``mail_policy_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_policy_add", ("client_id", client_id), ("params", params)) + + def mail_policy_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_policy_delete``. + + Source: ``mail.inc.php`` line 912. + PHP signature: ``mail_policy_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_policy_delete", ("primary_id", primary_id)) + + def mail_policy_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_policy_get``. + + Source: ``mail.inc.php`` line 876. + PHP signature: ``mail_policy_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_policy_get", ("primary_id", primary_id)) + + def mail_policy_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_policy_update``. + + Source: ``mail.inc.php`` line 900. + PHP signature: ``mail_policy_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_policy_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_relay_domain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_domain_add``. + + Source: ``mail.inc.php`` line 678. + PHP signature: ``mail_relay_domain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_relay_domain_add", ("client_id", client_id), ("params", params)) + + def mail_relay_domain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_domain_delete``. + + Source: ``mail.inc.php`` line 688. + PHP signature: ``mail_relay_domain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_relay_domain_delete", ("primary_id", primary_id)) + + def mail_relay_domain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_domain_get``. + + Source: ``mail.inc.php`` line 699. + PHP signature: ``mail_relay_domain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_relay_domain_get", ("primary_id", primary_id)) + + def mail_relay_domain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_domain_update``. + + Source: ``mail.inc.php`` line 713. + PHP signature: ``mail_relay_domain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_relay_domain_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_relay_recipient_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_recipient_add``. + + Source: ``mail.inc.php`` line 642. + PHP signature: ``mail_relay_recipient_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_relay_recipient_add", ("client_id", client_id), ("params", params)) + + def mail_relay_recipient_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_recipient_delete``. + + Source: ``mail.inc.php`` line 664. + PHP signature: ``mail_relay_recipient_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_relay_recipient_delete", ("primary_id", primary_id)) + + def mail_relay_recipient_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_recipient_get``. + + Source: ``mail.inc.php`` line 627. + PHP signature: ``mail_relay_recipient_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_relay_recipient_get", ("primary_id", primary_id)) + + def mail_relay_recipient_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_relay_recipient_update``. + + Source: ``mail.inc.php`` line 652. + PHP signature: ``mail_relay_recipient_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_relay_recipient_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_spamfilter_blacklist_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_blacklist_add``. + + Source: ``mail.inc.php`` line 790. + PHP signature: ``mail_spamfilter_blacklist_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_blacklist_add", ("client_id", client_id), ("params", params)) + + def mail_spamfilter_blacklist_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_blacklist_delete``. + + Source: ``mail.inc.php`` line 812. + PHP signature: ``mail_spamfilter_blacklist_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_blacklist_delete", ("primary_id", primary_id)) + + def mail_spamfilter_blacklist_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_blacklist_get``. + + Source: ``mail.inc.php`` line 776. + PHP signature: ``mail_spamfilter_blacklist_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_blacklist_get", ("primary_id", primary_id)) + + def mail_spamfilter_blacklist_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_blacklist_update``. + + Source: ``mail.inc.php`` line 800. + PHP signature: ``mail_spamfilter_blacklist_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_spamfilter_blacklist_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_spamfilter_user_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_user_add``. + + Source: ``mail.inc.php`` line 840. + PHP signature: ``mail_spamfilter_user_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_user_add", ("client_id", client_id), ("params", params)) + + def mail_spamfilter_user_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_user_delete``. + + Source: ``mail.inc.php`` line 862. + PHP signature: ``mail_spamfilter_user_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_user_delete", ("primary_id", primary_id)) + + def mail_spamfilter_user_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_user_get``. + + Source: ``mail.inc.php`` line 826. + PHP signature: ``mail_spamfilter_user_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_user_get", ("primary_id", primary_id)) + + def mail_spamfilter_user_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_user_update``. + + Source: ``mail.inc.php`` line 850. + PHP signature: ``mail_spamfilter_user_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_spamfilter_user_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_spamfilter_whitelist_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_whitelist_add``. + + Source: ``mail.inc.php`` line 740. + PHP signature: ``mail_spamfilter_whitelist_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_whitelist_add", ("client_id", client_id), ("params", params)) + + def mail_spamfilter_whitelist_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_whitelist_delete``. + + Source: ``mail.inc.php`` line 762. + PHP signature: ``mail_spamfilter_whitelist_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_whitelist_delete", ("primary_id", primary_id)) + + def mail_spamfilter_whitelist_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_whitelist_get``. + + Source: ``mail.inc.php`` line 726. + PHP signature: ``mail_spamfilter_whitelist_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_spamfilter_whitelist_get", ("primary_id", primary_id)) + + def mail_spamfilter_whitelist_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_spamfilter_whitelist_update``. + + Source: ``mail.inc.php`` line 750. + PHP signature: ``mail_spamfilter_whitelist_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_spamfilter_whitelist_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_transport_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_transport_add``. + + Source: ``mail.inc.php`` line 591. + PHP signature: ``mail_transport_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_transport_add", ("client_id", client_id), ("params", params)) + + def mail_transport_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_transport_delete``. + + Source: ``mail.inc.php`` line 613. + PHP signature: ``mail_transport_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_transport_delete", ("primary_id", primary_id)) + + def mail_transport_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_transport_get``. + + Source: ``mail.inc.php`` line 577. + PHP signature: ``mail_transport_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_transport_get", ("primary_id", primary_id)) + + def mail_transport_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_transport_update``. + + Source: ``mail.inc.php`` line 601. + PHP signature: ``mail_transport_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_transport_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_user_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_add``. + + Source: ``mail.inc.php`` line 226. + PHP signature: ``mail_user_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_add", ("client_id", client_id), ("params", params)) + + def mail_user_backup(self, primary_id: Any, action_type: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_backup``. + + Source: ``mail.inc.php`` line 366. + PHP signature: ``mail_user_backup($session_id, $primary_id, $action_type)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_backup", ("primary_id", primary_id), ("action_type", action_type)) + + def mail_user_backup_list(self, primary_id: Any = None) -> Any: + """ + Auto-generated wrapper for ``mail_user_backup_list``. + + Source: ``mail.inc.php`` line 343. + PHP signature: ``mail_user_backup_list($session_id, $primary_id = null)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_backup_list", ("primary_id", primary_id)) + + def mail_user_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_delete``. + + Source: ``mail.inc.php`` line 279. + PHP signature: ``mail_user_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_delete", ("primary_id", primary_id)) + + def mail_user_filter_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_filter_add``. + + Source: ``mail.inc.php`` line 303. + PHP signature: ``mail_user_filter_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_filter_add", ("client_id", client_id), ("params", params)) + + def mail_user_filter_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_filter_delete``. + + Source: ``mail.inc.php`` line 328. + PHP signature: ``mail_user_filter_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_filter_delete", ("primary_id", primary_id)) + + def mail_user_filter_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_filter_get``. + + Source: ``mail.inc.php`` line 291. + PHP signature: ``mail_user_filter_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_filter_get", ("primary_id", primary_id)) + + def mail_user_filter_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_filter_update``. + + Source: ``mail.inc.php`` line 315. + PHP signature: ``mail_user_filter_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_user_filter_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def mail_user_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_get``. + + Source: ``mail.inc.php`` line 193. + PHP signature: ``mail_user_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_get", ("primary_id", primary_id)) + + def mail_user_get_all_by_client(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_get_all_by_client``. + + Source: ``mail.inc.php`` line 207. + PHP signature: ``mail_user_get_all_by_client($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_user_get_all_by_client", ("client_id", client_id)) + + def mail_user_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_user_update``. + + Source: ``mail.inc.php`` line 255. + PHP signature: ``mail_user_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_user_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mail_whitelist_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_whitelist_add``. + + Source: ``mail.inc.php`` line 990. + PHP signature: ``mail_whitelist_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_whitelist_add", ("client_id", client_id), ("params", params)) + + def mail_whitelist_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_whitelist_delete``. + + Source: ``mail.inc.php`` line 1012. + PHP signature: ``mail_whitelist_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_whitelist_delete", ("primary_id", primary_id)) + + def mail_whitelist_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``mail_whitelist_get``. + + Source: ``mail.inc.php`` line 976. + PHP signature: ``mail_whitelist_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mail_whitelist_get", ("primary_id", primary_id)) + + def mail_whitelist_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``mail_whitelist_update``. + + Source: ``mail.inc.php`` line 1000. + PHP signature: ``mail_whitelist_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "mail_whitelist_update", ("client_id", client_id), ("primary_id", primary_id), ("params", params) + ) + + def mailquota_get_by_user(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``mailquota_get_by_user``. + + Source: ``mail.inc.php`` line 1171. + PHP signature: ``mailquota_get_by_user($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("mailquota_get_by_user", ("client_id", client_id)) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + # ---- mail domains ------------------------------------------------- def domain_get(self, primary_id: int) -> MailDomain: @@ -33,19 +1095,23 @@ class MailModule: return self._c._call("mail_domain_get_by_domain", ("domain", domain)) or [] def domain_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "mail_domain_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "mail_domain_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def domain_update(self, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "mail_domain_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "mail_domain_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) def domain_delete(self, primary_id: int) -> int: return int(self._c._call("mail_domain_delete", ("primary_id", int(primary_id)))) @@ -76,19 +1142,23 @@ class MailModule: return cast(MailUser, self._c._call("mail_user_get", ("primary_id", int(primary_id)))) def user_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "mail_user_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "mail_user_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def user_update(self, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "mail_user_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "mail_user_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) def user_delete(self, primary_id: int) -> int: return int(self._c._call("mail_user_delete", ("primary_id", int(primary_id)))) @@ -96,19 +1166,23 @@ class MailModule: # ---- mail forward ------------------------------------------------- def forward_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "mail_forward_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "mail_forward_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def forward_update(self, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "mail_forward_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "mail_forward_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) def forward_delete(self, primary_id: int) -> int: return int(self._c._call("mail_forward_delete", ("primary_id", int(primary_id)))) diff --git a/src/ispconfig/misc.py b/src/ispconfig/misc.py new file mode 100644 index 0000000..70c42d1 --- /dev/null +++ b/src/ispconfig/misc.py @@ -0,0 +1,81 @@ +"""``misc.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class MiscModule: + """Auto-generated module: Misc. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def databasequota_get_by_user(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``databasequota_get_by_user``. + + Source: ``sites.inc.php`` line 1012. + PHP signature: ``databasequota_get_by_user($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("databasequota_get_by_user", ("client_id", client_id)) + + def ftptrafficquota_data(self, client_id: Any, lastdays: Any = 0) -> Any: + """ + Auto-generated wrapper for ``ftptrafficquota_data``. + + Source: ``sites.inc.php`` line 997. + PHP signature: ``ftptrafficquota_data($session_id, $client_id, $lastdays = 0)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("ftptrafficquota_data", ("client_id", client_id), ("lastdays", lastdays)) + + def quota_get_by_user(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``quota_get_by_user``. + + Source: ``sites.inc.php`` line 970. + PHP signature: ``quota_get_by_user($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("quota_get_by_user", ("client_id", client_id)) + + def trafficquota_get_by_user(self, client_id: Any, lastdays: Any = 0) -> Any: + """ + Auto-generated wrapper for ``trafficquota_get_by_user``. + + Source: ``sites.inc.php`` line 982. + PHP signature: ``trafficquota_get_by_user($session_id, $client_id, $lastdays = 0)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("trafficquota_get_by_user", ("client_id", client_id), ("lastdays", lastdays)) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/monitor.py b/src/ispconfig/monitor.py new file mode 100644 index 0000000..8877b75 --- /dev/null +++ b/src/ispconfig/monitor.py @@ -0,0 +1,45 @@ +"""``monitor.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class MonitorModule: + """Auto-generated module: Monitor. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def monitor_jobqueue_count(self, server_id: Any = 0) -> Any: + """ + Auto-generated wrapper for ``monitor_jobqueue_count``. + + Source: ``monitor.inc.php`` line 36. + PHP signature: ``monitor_jobqueue_count($session_id, $server_id = 0)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("monitor_jobqueue_count", ("server_id", server_id)) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/openvz.py b/src/ispconfig/openvz.py new file mode 100644 index 0000000..81581cd --- /dev/null +++ b/src/ispconfig/openvz.py @@ -0,0 +1,319 @@ +"""``openvz.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class OpenvzModule: + """Auto-generated module: Openvz. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def openvz_get_free_ip(self, server_id: Any = 0) -> Any: + """ + Auto-generated wrapper for ``openvz_get_free_ip``. + + Source: ``openvz.inc.php`` line 151. + PHP signature: ``openvz_get_free_ip($session_id, $server_id = 0)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_get_free_ip", ("server_id", server_id)) + + def openvz_ip_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ip_add``. + + Source: ``openvz.inc.php`` line 175. + PHP signature: ``openvz_ip_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_ip_add", ("client_id", client_id), ("params", params)) + + def openvz_ip_delete(self, ip_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ip_delete``. + + Source: ``openvz.inc.php`` line 196. + PHP signature: ``openvz_ip_delete($session_id, $ip_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_ip_delete", ("ip_id", ip_id)) + + def openvz_ip_get(self, ip_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ip_get``. + + Source: ``openvz.inc.php`` line 137. + PHP signature: ``openvz_ip_get($session_id, $ip_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_ip_get", ("ip_id", ip_id)) + + def openvz_ip_update(self, client_id: Any, ip_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ip_update``. + + Source: ``openvz.inc.php`` line 185. + PHP signature: ``openvz_ip_update($session_id, $client_id, $ip_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "openvz_ip_update", ("client_id", client_id), ("ip_id", ip_id), ("params", params) + ) + + def openvz_ostemplate_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ostemplate_add``. + + Source: ``openvz.inc.php`` line 59. + PHP signature: ``openvz_ostemplate_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_ostemplate_add", ("client_id", client_id), ("params", params)) + + def openvz_ostemplate_delete(self, ostemplate_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ostemplate_delete``. + + Source: ``openvz.inc.php`` line 80. + PHP signature: ``openvz_ostemplate_delete($session_id, $ostemplate_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_ostemplate_delete", ("ostemplate_id", ostemplate_id)) + + def openvz_ostemplate_get(self, ostemplate_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ostemplate_get``. + + Source: ``openvz.inc.php`` line 45. + PHP signature: ``openvz_ostemplate_get($session_id, $ostemplate_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_ostemplate_get", ("ostemplate_id", ostemplate_id)) + + def openvz_ostemplate_update(self, client_id: Any, ostemplate_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_ostemplate_update``. + + Source: ``openvz.inc.php`` line 69. + PHP signature: ``openvz_ostemplate_update($session_id, $client_id, $ostemplate_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "openvz_ostemplate_update", + ("client_id", client_id), + ("ostemplate_id", ostemplate_id), + ("params", params), + ) + + def openvz_template_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_template_add``. + + Source: ``openvz.inc.php`` line 105. + PHP signature: ``openvz_template_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_template_add", ("client_id", client_id), ("params", params)) + + def openvz_template_delete(self, template_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_template_delete``. + + Source: ``openvz.inc.php`` line 126. + PHP signature: ``openvz_template_delete($session_id, $template_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_template_delete", ("template_id", template_id)) + + def openvz_template_get(self, template_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_template_get``. + + Source: ``openvz.inc.php`` line 91. + PHP signature: ``openvz_template_get($session_id, $template_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_template_get", ("template_id", template_id)) + + def openvz_template_update(self, client_id: Any, template_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_template_update``. + + Source: ``openvz.inc.php`` line 115. + PHP signature: ``openvz_template_update($session_id, $client_id, $template_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "openvz_template_update", + ("client_id", client_id), + ("template_id", template_id), + ("params", params), + ) + + def openvz_vm_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_add``. + + Source: ``openvz.inc.php`` line 241. + PHP signature: ``openvz_vm_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_vm_add", ("client_id", client_id), ("params", params)) + + def openvz_vm_add_from_template( + self, client_id: Any, ostemplate_id: Any, template_id: Any, override_params: Any = None + ) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_add_from_template``. + + Source: ``openvz.inc.php`` line 251. + PHP signature: ``openvz_vm_add_from_template($session_id, $client_id, $ostemplate_id, $template_id, $override_params = array())``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "openvz_vm_add_from_template", + ("client_id", client_id), + ("ostemplate_id", ostemplate_id), + ("template_id", template_id), + ("override_params", override_params), + ) + + def openvz_vm_delete(self, vm_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_delete``. + + Source: ``openvz.inc.php`` line 342. + PHP signature: ``openvz_vm_delete($session_id, $vm_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_vm_delete", ("vm_id", vm_id)) + + def openvz_vm_get(self, vm_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_get``. + + Source: ``openvz.inc.php`` line 207. + PHP signature: ``openvz_vm_get($session_id, $vm_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_vm_get", ("vm_id", vm_id)) + + def openvz_vm_get_by_client(self, client_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_get_by_client``. + + Source: ``openvz.inc.php`` line 221. + PHP signature: ``openvz_vm_get_by_client($session_id, $client_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_vm_get_by_client", ("client_id", client_id)) + + def openvz_vm_restart(self, vm_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_restart``. + + Source: ``openvz.inc.php`` line 437. + PHP signature: ``openvz_vm_restart($session_id, $vm_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_vm_restart", ("vm_id", vm_id)) + + def openvz_vm_start(self, vm_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_start``. + + Source: ``openvz.inc.php`` line 353. + PHP signature: ``openvz_vm_start($session_id, $vm_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_vm_start", ("vm_id", vm_id)) + + def openvz_vm_stop(self, vm_id: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_stop``. + + Source: ``openvz.inc.php`` line 395. + PHP signature: ``openvz_vm_stop($session_id, $vm_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("openvz_vm_stop", ("vm_id", vm_id)) + + def openvz_vm_update(self, client_id: Any, vm_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``openvz_vm_update``. + + Source: ``openvz.inc.php`` line 331. + PHP signature: ``openvz_vm_update($session_id, $client_id, $vm_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "openvz_vm_update", ("client_id", client_id), ("vm_id", vm_id), ("params", params) + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/server.py b/src/ispconfig/server.py new file mode 100644 index 0000000..fca4011 --- /dev/null +++ b/src/ispconfig/server.py @@ -0,0 +1,215 @@ +"""``server.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class ServerModule: + """Auto-generated module: Server. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def server_config_set(self, server_id: Any, section: str, key: str, value: Any) -> Any: + """ + Set a value in the server configuration + + Source: ``server.inc.php`` line 153. + PHP signature: ``server_config_set($session_id, $server_id, $section, $key, $value)``. + + Params (from PHPDoc): + session (int): id + server (int): id + section (string): of the config field in the server table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc + key (string): of the option that you want to set + option (string): value that you want to set + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "server_config_set", + ("server_id", server_id), + ("section", section), + ("key", key), + ("value", value), + ) + + def server_get(self, server_id: Any = None, section: str = "") -> Any: + """ + Gets the server configuration + + Source: ``server.inc.php`` line 116. + PHP signature: ``server_get($session_id, $server_id = null, $section ='')``. + + Params (from PHPDoc): + session (int): id + server (int): id + section (string): of the config field in the server table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_get", ("server_id", server_id), ("section", section)) + + def server_get_all(self) -> Any: + """ + Gets a list of all servers + + Source: ``server.inc.php`` line 179. + + Params (from PHPDoc): + server_name (int) + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_get_all") + + def server_get_app_version(self, server_id: Any = 0) -> Any: + """ + Auto-generated wrapper for ``server_get_app_version``. + + Source: ``server.inc.php`` line 238. + PHP signature: ``server_get_app_version($session_id, $server_id = 0)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_get_app_version", ("server_id", server_id)) + + def server_get_functions(self, server_id: int) -> Any: + """ + Gets the functions of a server by server_id + + Source: ``server.inc.php`` line 223. + PHP signature: ``server_get_functions($session_id, $server_id)``. + + Params (from PHPDoc): + server_id (int) + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_get_functions", ("server_id", server_id)) + + def server_get_php_versions(self, server_id: Any, php: Any, get_full_data: Any = False) -> Any: + """ + Auto-generated wrapper for ``server_get_php_versions``. + + Source: ``server.inc.php`` line 259. + PHP signature: ``server_get_php_versions($session_id, $server_id, $php, $get_full_data = false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "server_get_php_versions", + ("server_id", server_id), + ("php", php), + ("get_full_data", get_full_data), + ) + + def server_get_serverid_by_ip(self, ipaddress: Any) -> Any: + """ + Gets the server configuration + + Source: ``server.inc.php`` line 49. + PHP signature: ``server_get_serverid_by_ip($session_id, $ipaddress)``. + + Params (from PHPDoc): + session (int): id + server (int): id + section (string): of the config field in the server table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_get_serverid_by_ip", ("ipaddress", ipaddress)) + + def server_get_serverid_by_name(self, server_name: int) -> Any: + """ + Gets the server_id by server_name + + Source: ``server.inc.php`` line 201. + PHP signature: ``server_get_serverid_by_name($session_id, $server_name)``. + + Params (from PHPDoc): + server_name (int) + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_get_serverid_by_name", ("server_name", server_name)) + + def server_ip_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``server_ip_add``. + + Source: ``server.inc.php`` line 78. + PHP signature: ``server_ip_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_ip_add", ("client_id", client_id), ("params", params)) + + def server_ip_delete(self, ip_id: Any) -> Any: + """ + Auto-generated wrapper for ``server_ip_delete``. + + Source: ``server.inc.php`` line 99. + PHP signature: ``server_ip_delete($session_id, $ip_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_ip_delete", ("ip_id", ip_id)) + + def server_ip_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``server_ip_get``. + + Source: ``server.inc.php`` line 64. + PHP signature: ``server_ip_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("server_ip_get", ("primary_id", primary_id)) + + def server_ip_update(self, client_id: Any, ip_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``server_ip_update``. + + Source: ``server.inc.php`` line 88. + PHP signature: ``server_ip_update($session_id, $client_id, $ip_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "server_ip_update", ("client_id", client_id), ("ip_id", ip_id), ("params", params) + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/shell.py b/src/ispconfig/shell.py new file mode 100644 index 0000000..3efd0b2 --- /dev/null +++ b/src/ispconfig/shell.py @@ -0,0 +1,86 @@ +"""``shell.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class ShellModule: + """Auto-generated module: Shell. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_shell_user_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_shell_user_add``. + + Source: ``sites.inc.php`` line 368. + PHP signature: ``sites_shell_user_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_shell_user_add", ("client_id", client_id), ("params", params)) + + def sites_shell_user_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_shell_user_delete``. + + Source: ``sites.inc.php`` line 389. + PHP signature: ``sites_shell_user_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_shell_user_delete", ("primary_id", primary_id)) + + def sites_shell_user_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_shell_user_get``. + + Source: ``sites.inc.php`` line 354. + PHP signature: ``sites_shell_user_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_shell_user_get", ("primary_id", primary_id)) + + def sites_shell_user_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_shell_user_update``. + + Source: ``sites.inc.php`` line 378. + PHP signature: ``sites_shell_user_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_shell_user_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/src/ispconfig/sites.py b/src/ispconfig/sites.py index a736669..a1a7680 100644 --- a/src/ispconfig/sites.py +++ b/src/ispconfig/sites.py @@ -31,6 +31,409 @@ class SitesModule: def __init__(self, client: ISPConfigClient) -> None: self._c = client + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_web_aliasdomain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_aliasdomain_add``. + + Source: ``sites.inc.php`` line 642. + PHP signature: ``sites_web_aliasdomain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_aliasdomain_add", ("client_id", client_id), ("params", params)) + + def sites_web_aliasdomain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_aliasdomain_delete``. + + Source: ``sites.inc.php`` line 663. + PHP signature: ``sites_web_aliasdomain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_aliasdomain_delete", ("primary_id", primary_id)) + + def sites_web_aliasdomain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_aliasdomain_get``. + + Source: ``sites.inc.php`` line 628. + PHP signature: ``sites_web_aliasdomain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_aliasdomain_get", ("primary_id", primary_id)) + + def sites_web_aliasdomain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_aliasdomain_update``. + + Source: ``sites.inc.php`` line 652. + PHP signature: ``sites_web_aliasdomain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_aliasdomain_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def sites_web_domain_add(self, client_id: Any, params: Any, readonly: Any = False) -> Any: + """ + Auto-generated wrapper for ``sites_web_domain_add``. + + Source: ``sites.inc.php`` line 416. + PHP signature: ``sites_web_domain_add($session_id, $client_id, $params, $readonly = false)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_domain_add", ("client_id", client_id), ("params", params), ("readonly", readonly) + ) + + def sites_web_domain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_domain_delete``. + + Source: ``sites.inc.php`` line 471. + PHP signature: ``sites_web_domain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_domain_delete", ("primary_id", primary_id)) + + def sites_web_domain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_domain_get``. + + Source: ``sites.inc.php`` line 402. + PHP signature: ``sites_web_domain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_domain_get", ("primary_id", primary_id)) + + def sites_web_domain_set_status(self, primary_id: Any, status: Any) -> Any: + """ + Change domains status + + Source: ``sites.inc.php`` line 870. + PHP signature: ``sites_web_domain_set_status($session_id, $primary_id, $status)``. + + Params (from PHPDoc): + session (int): id + site (int): id + active (string): or inactive string + + Returns: mixed - false if error + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_domain_set_status", ("primary_id", primary_id), ("status", status)) + + def sites_web_domain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_domain_update``. + + Source: ``sites.inc.php`` line 451. + PHP signature: ``sites_web_domain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_domain_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def sites_web_folder_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_add``. + + Source: ``sites.inc.php`` line 738. + PHP signature: ``sites_web_folder_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_folder_add", ("client_id", client_id), ("params", params)) + + def sites_web_folder_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_delete``. + + Source: ``sites.inc.php`` line 759. + PHP signature: ``sites_web_folder_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_folder_delete", ("primary_id", primary_id)) + + def sites_web_folder_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_get``. + + Source: ``sites.inc.php`` line 724. + PHP signature: ``sites_web_folder_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_folder_get", ("primary_id", primary_id)) + + def sites_web_folder_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_update``. + + Source: ``sites.inc.php`` line 748. + PHP signature: ``sites_web_folder_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_folder_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def sites_web_folder_user_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_user_add``. + + Source: ``sites.inc.php`` line 796. + PHP signature: ``sites_web_folder_user_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_folder_user_add", ("client_id", client_id), ("params", params)) + + def sites_web_folder_user_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_user_delete``. + + Source: ``sites.inc.php`` line 817. + PHP signature: ``sites_web_folder_user_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_folder_user_delete", ("primary_id", primary_id)) + + def sites_web_folder_user_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_user_get``. + + Source: ``sites.inc.php`` line 782. + PHP signature: ``sites_web_folder_user_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_folder_user_get", ("primary_id", primary_id)) + + def sites_web_folder_user_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_folder_user_update``. + + Source: ``sites.inc.php`` line 806. + PHP signature: ``sites_web_folder_user_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_folder_user_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def sites_web_subdomain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_subdomain_add``. + + Source: ``sites.inc.php`` line 690. + PHP signature: ``sites_web_subdomain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_subdomain_add", ("client_id", client_id), ("params", params)) + + def sites_web_subdomain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_subdomain_delete``. + + Source: ``sites.inc.php`` line 711. + PHP signature: ``sites_web_subdomain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_subdomain_delete", ("primary_id", primary_id)) + + def sites_web_subdomain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_subdomain_get``. + + Source: ``sites.inc.php`` line 676. + PHP signature: ``sites_web_subdomain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_subdomain_get", ("primary_id", primary_id)) + + def sites_web_subdomain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_subdomain_update``. + + Source: ``sites.inc.php`` line 700. + PHP signature: ``sites_web_subdomain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_subdomain_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def sites_web_vhost_aliasdomain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_aliasdomain_add``. + + Source: ``sites.inc.php`` line 498. + PHP signature: ``sites_web_vhost_aliasdomain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_vhost_aliasdomain_add", ("client_id", client_id), ("params", params)) + + def sites_web_vhost_aliasdomain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_aliasdomain_delete``. + + Source: ``sites.inc.php`` line 543. + PHP signature: ``sites_web_vhost_aliasdomain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_vhost_aliasdomain_delete", ("primary_id", primary_id)) + + def sites_web_vhost_aliasdomain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_aliasdomain_get``. + + Source: ``sites.inc.php`` line 484. + PHP signature: ``sites_web_vhost_aliasdomain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_vhost_aliasdomain_get", ("primary_id", primary_id)) + + def sites_web_vhost_aliasdomain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_aliasdomain_update``. + + Source: ``sites.inc.php`` line 523. + PHP signature: ``sites_web_vhost_aliasdomain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_vhost_aliasdomain_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + def sites_web_vhost_subdomain_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_subdomain_add``. + + Source: ``sites.inc.php`` line 570. + PHP signature: ``sites_web_vhost_subdomain_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_vhost_subdomain_add", ("client_id", client_id), ("params", params)) + + def sites_web_vhost_subdomain_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_subdomain_delete``. + + Source: ``sites.inc.php`` line 615. + PHP signature: ``sites_web_vhost_subdomain_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_vhost_subdomain_delete", ("primary_id", primary_id)) + + def sites_web_vhost_subdomain_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_subdomain_get``. + + Source: ``sites.inc.php`` line 556. + PHP signature: ``sites_web_vhost_subdomain_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_web_vhost_subdomain_get", ("primary_id", primary_id)) + + def sites_web_vhost_subdomain_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_web_vhost_subdomain_update``. + + Source: ``sites.inc.php`` line 595. + PHP signature: ``sites_web_vhost_subdomain_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_web_vhost_subdomain_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + + # ---- HAND-EDIT ONLY BELOW ---- + # ---- web domain --------------------------------------------------- def web_domain_get(self, primary_id: int) -> WebDomain: @@ -42,12 +445,14 @@ class SitesModule: ``client_id=0`` creates an admin-owned site. """ - return int(self._c._call( - "sites_web_domain_add", - ("client_id", int(client_id)), - ("params", dict(params)), - ("read_only", bool(read_only)), - )) + return int( + self._c._call( + "sites_web_domain_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ("read_only", bool(read_only)), + ) + ) def web_domain_update(self, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: """Update a site. @@ -56,23 +461,27 @@ class SitesModule: The second positional arg is ``client_id``, not ``primary_id``. Pass 0 for admin-owned. See module docstring. """ - return int(self._c._call( - "sites_web_domain_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "sites_web_domain_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) def web_domain_delete(self, primary_id: int) -> int: return int(self._c._call("sites_web_domain_delete", ("primary_id", int(primary_id)))) def web_domain_set_status(self, primary_id: int, status: str) -> int: """``status`` is typically ``'active'`` or ``'inactive'``.""" - return int(self._c._call( - "sites_web_domain_set_status", - ("primary_id", int(primary_id)), - ("status", status), - )) + return int( + self._c._call( + "sites_web_domain_set_status", + ("primary_id", int(primary_id)), + ("status", status), + ) + ) # ---- helpers ------------------------------------------------------ @@ -129,11 +538,13 @@ class SitesModule: return cast(Database, self._c._call("sites_database_get", ("primary_id", int(primary_id)))) def database_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "sites_database_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "sites_database_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def database_delete(self, primary_id: int) -> int: return int(self._c._call("sites_database_delete", ("primary_id", int(primary_id)))) @@ -142,16 +553,20 @@ class SitesModule: return cast(DatabaseUser, self._c._call("sites_database_user_get", ("primary_id", int(primary_id)))) def database_user_add(self, client_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "sites_database_user_add", - ("client_id", int(client_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "sites_database_user_add", + ("client_id", int(client_id)), + ("params", dict(params)), + ) + ) def database_user_update(self, client_id: int, primary_id: int, params: Mapping[str, Any]) -> int: - return int(self._c._call( - "sites_database_user_update", - ("client_id", int(client_id)), - ("primary_id", int(primary_id)), - ("params", dict(params)), - )) + return int( + self._c._call( + "sites_database_user_update", + ("client_id", int(client_id)), + ("primary_id", int(primary_id)), + ("params", dict(params)), + ) + ) diff --git a/src/ispconfig/webdav.py b/src/ispconfig/webdav.py new file mode 100644 index 0000000..22e4ea4 --- /dev/null +++ b/src/ispconfig/webdav.py @@ -0,0 +1,86 @@ +"""``webdav.*`` — auto-generated ISPConfig remote-API wrappers. + +This module is produced by ``tools/gen_methods.py`` from the +``tools/method_inventory.json`` catalog. Hand-edits go below the +``---- HAND-EDIT ONLY BELOW ----`` marker — they survive regeneration. +""" + +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from .client import ISPConfigClient + + +class WebdavModule: + """Auto-generated module: Webdav. + + All methods below the ``AUTO-GENERATED START`` marker are produced + by ``tools/gen_methods.py``. Do not hand-edit that block — changes + will be overwritten on the next regeneration. Add helpers and + overrides below the ``HAND-EDIT ONLY BELOW`` marker instead. + """ + + def __init__(self, client: ISPConfigClient) -> None: + self._c = client + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + # Regenerate with: python3 tools/gen_methods.py + + def sites_webdav_user_add(self, client_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_webdav_user_add``. + + Source: ``sites.inc.php`` line 1043. + PHP signature: ``sites_webdav_user_add($session_id, $client_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_webdav_user_add", ("client_id", client_id), ("params", params)) + + def sites_webdav_user_delete(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_webdav_user_delete``. + + Source: ``sites.inc.php`` line 1064. + PHP signature: ``sites_webdav_user_delete($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_webdav_user_delete", ("primary_id", primary_id)) + + def sites_webdav_user_get(self, primary_id: Any) -> Any: + """ + Auto-generated wrapper for ``sites_webdav_user_get``. + + Source: ``sites.inc.php`` line 1029. + PHP signature: ``sites_webdav_user_get($session_id, $primary_id)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call("sites_webdav_user_get", ("primary_id", primary_id)) + + def sites_webdav_user_update(self, client_id: Any, primary_id: Any, params: Any) -> Any: + """ + Auto-generated wrapper for ``sites_webdav_user_update``. + + Source: ``sites.inc.php`` line 1053. + PHP signature: ``sites_webdav_user_update($session_id, $client_id, $primary_id, $params)``. + + AUTO-GENERATED - param shapes may need verification against your + ISPConfig version. File issues at Sulkta-Coop/ispconfig-py. + """ + return self._c._call( + "sites_webdav_user_update", + ("client_id", client_id), + ("primary_id", primary_id), + ("params", params), + ) + + # ---- AUTO-GENERATED END ---- + + # ---- HAND-EDIT ONLY BELOW ---- diff --git a/tests/conftest.py b/tests/conftest.py index 259db99..18e670d 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -3,6 +3,9 @@ Live-smoke tests read ``ISPCONFIG_TEST_URL``, ``ISPCONFIG_TEST_USER``, and ``ISPCONFIG_TEST_PASS`` from the environment. If any is missing, those tests are skipped — so the default ``pytest`` run on a laptop never phones home. + +Set ``ISPCONFIG_TEST_VERIFY_SSL=0`` for panels with self-signed or +mismatched certs. """ from __future__ import annotations @@ -19,4 +22,5 @@ def live_creds() -> dict[str, str]: password = os.environ.get("ISPCONFIG_TEST_PASS") if not (url and user and password): pytest.skip("live smoke test: set ISPCONFIG_TEST_URL/USER/PASS to enable") - return {"url": url, "user": user, "password": password} + verify = os.environ.get("ISPCONFIG_TEST_VERIFY_SSL", "1") + return {"url": url, "user": user, "password": password, "verify": verify} diff --git a/tests/test_smoke.py b/tests/test_smoke.py index 6852f1d..6b7f67b 100644 --- a/tests/test_smoke.py +++ b/tests/test_smoke.py @@ -5,23 +5,40 @@ Gated on env vars: ``ISPCONFIG_TEST_URL``, ``ISPCONFIG_TEST_USER``, They are **read-only** — no ``_add`` / ``_update`` / ``_delete`` calls. Safe to run against production (Rackham). + +Every new auto-generated module gets at least one read-only call here so we +know the wrappers actually wire up against a live panel. Methods that the +API user lacks permission for (admin-only, etc.) are documented skips — +see the README's "Known admin-only" list. """ from __future__ import annotations +from collections.abc import Iterator + import pytest -from ispconfig import ISPConfigClient +from ispconfig import ISPConfigClient, NotFoundError, PermissionError @pytest.fixture() -def client(live_creds: dict[str, str]) -> ISPConfigClient: - with ISPConfigClient(live_creds["url"], live_creds["user"], live_creds["password"]) as c: - yield c # type: ignore[misc] +def client(live_creds: dict[str, str]) -> Iterator[ISPConfigClient]: + verify = live_creds.get("verify", "1") not in ("0", "false", "False") + with ISPConfigClient( + live_creds["url"], + live_creds["user"], + live_creds["password"], + verify_ssl=verify, + ) as c: + yield c + + +# ---- hand-audited modules (first pass) ----------------------------------- def test_login_returns_session(live_creds: dict[str, str]) -> None: - c = ISPConfigClient(live_creds["url"], live_creds["user"], live_creds["password"]) + verify = live_creds.get("verify", "1") not in ("0", "false", "False") + c = ISPConfigClient(live_creds["url"], live_creds["user"], live_creds["password"], verify_ssl=verify) c.login() assert c.session_id and len(c.session_id) > 10 assert c.logout() is True @@ -45,3 +62,193 @@ def test_mail_users_under_mcbindustrial(client: ISPConfigClient) -> None: # Don't assert count — just shape. Zero mailboxes is a valid state. for u in users: assert "email" in u + + +# ---- auto-generated modules: one read-only probe each ------------------- +# +# These prove the wrappers encode/decode correctly against a real panel. +# Each test tolerates the method being restricted to admin (``kayos`` is a +# reseller, not an admin) — those skip with a clear reason. + + +def test_raw_call_list_functions(client: ISPConfigClient) -> None: + """``list_functions`` is the introspection escape hatch — sanity check it.""" + funcs = client.list_functions() + assert "sites_web_domain_get" in funcs + assert "mail_user_get" in funcs + # 300+ is typical for a modern ISPConfig. + assert len(funcs) > 200 + + +def test_raw_call_escape_hatch(client: ISPConfigClient) -> None: + """``raw_call`` must route through the same retry/fault-mapping pipeline.""" + # ``client_get_all`` is a no-arg read. + ids = client.raw_call("client_get_all") + assert ids is None or isinstance(ids, (list, dict)) + + +def test_clients_client_get_all(client: ISPConfigClient) -> None: + ids = client.clients.get_all() + assert isinstance(ids, list) + # Don't assert count — panel may be empty of managed clients. + + +def test_clients_templates_get_all(client: ISPConfigClient) -> None: + try: + tpls = client.clients.client_templates_get_all() + except PermissionError: + pytest.skip("client_templates_get_all: admin-only on this panel") + assert tpls is None or isinstance(tpls, (list, dict)) + + +def test_server_get_all(client: ISPConfigClient) -> None: + try: + servers = client.server.server_get_all() + except PermissionError: + pytest.skip("server_get_all: admin-only on this panel") + assert servers is None or isinstance(servers, (list, dict)) + + +def test_server_get_functions(client: ISPConfigClient) -> None: + """Pick the first server id and ask which modules it runs.""" + try: + servers = client.server.server_get_all() + except PermissionError: + pytest.skip("server_get_all: admin-only on this panel") + if not servers: + pytest.skip("no servers visible to this API user") + # ``server_get_all`` returns a list of server records. Grab the first id. + first = servers[0] if isinstance(servers, list) else next(iter(servers.values())) + server_id = int(first.get("server_id") if isinstance(first, dict) else first) + try: + fns = client.server.server_get_functions(server_id) + except PermissionError: + pytest.skip("server_get_functions: admin-only on this panel") + assert fns is None or isinstance(fns, (list, dict)) + + +def test_monitor_jobqueue_count(client: ISPConfigClient) -> None: + try: + n = client.monitor.monitor_jobqueue_count() + except PermissionError: + pytest.skip("monitor_jobqueue_count: admin-only on this panel") + # Returns an int-ish; ISPConfig may stringify. + assert n is None or isinstance(n, (int, str, dict, list)) + + +def test_admin_system_config_get(client: ISPConfigClient) -> None: + try: + cfg = client.admin.system_config_get("mail") + except PermissionError: + pytest.skip("system_config_get: admin-only on this panel") + assert cfg is None or isinstance(cfg, (dict, list, str)) + + +def test_ftp_user_get_missing(client: ISPConfigClient) -> None: + """Nonexistent primary_id → ``NotFoundError`` via the fault-map path.""" + try: + result = client.ftp.sites_ftp_user_get(999_999_999) + except NotFoundError: + return # expected + except PermissionError: + pytest.skip("sites_ftp_user_get: admin-only on this panel") + # Some panels return None/empty instead of a fault. + assert result in (None, {}, "", []) + + +def test_shell_user_get_missing(client: ISPConfigClient) -> None: + try: + result = client.shell.sites_shell_user_get(999_999_999) + except NotFoundError: + return + except PermissionError: + pytest.skip("sites_shell_user_get: admin-only on this panel") + assert result in (None, {}, "", []) + + +def test_webdav_user_get_missing(client: ISPConfigClient) -> None: + try: + result = client.webdav.sites_webdav_user_get(999_999_999) + except NotFoundError: + return + except PermissionError: + pytest.skip("sites_webdav_user_get: admin-only on this panel") + assert result in (None, {}, "", []) + + +def test_cron_get_missing(client: ISPConfigClient) -> None: + try: + result = client.cron.sites_cron_get(999_999_999) + except NotFoundError: + return + except PermissionError: + pytest.skip("sites_cron_get: admin-only on this panel") + assert result in (None, {}, "", []) + + +def test_backups_list(client: ISPConfigClient) -> None: + """``sites_web_domain_backup_list`` on a known domain.""" + try: + result = client.backups.sites_web_domain_backup_list(156) + except PermissionError: + pytest.skip("sites_web_domain_backup_list: admin-only on this panel") + except NotFoundError: + pytest.skip("no backups configured for domain 156") + assert result is None or isinstance(result, (list, dict)) + + +def test_aps_available_packages_list(client: ISPConfigClient) -> None: + try: + pkgs = client.aps.sites_aps_available_packages_list() + except PermissionError: + pytest.skip("sites_aps_available_packages_list: admin-only on this panel") + except NotFoundError: + pytest.skip("APS not initialized on this panel") + assert pkgs is None or isinstance(pkgs, (list, dict)) + + +def test_domains_get_all_by_user(client: ISPConfigClient) -> None: + """``domains`` is the (optional) domain-module — may not be installed.""" + try: + # group 1 = admin + domains = client.domains.domains_get_all_by_user(1) + except PermissionError: + pytest.skip("domains_get_all_by_user: admin-only or module disabled") + except NotFoundError: + pytest.skip("domains module not installed") + assert domains is None or isinstance(domains, (list, dict)) + + +def test_openvz_get_free_ip(client: ISPConfigClient) -> None: + """OpenVZ module may not be installed — skip cleanly if so.""" + try: + ip = client.openvz.openvz_get_free_ip() + except PermissionError: + pytest.skip("openvz_get_free_ip: admin-only or OpenVZ not installed") + except NotFoundError: + pytest.skip("OpenVZ not installed / no free IPs") + assert ip is None or isinstance(ip, (str, dict, list)) + + +def test_misc_quota_get_by_user(client: ISPConfigClient) -> None: + """``quota_get_by_user`` — look up one visible client, query its quota.""" + try: + ids = client.clients.get_all() + except PermissionError: + pytest.skip("client_get_all: admin-only on this panel") + if not ids: + pytest.skip("no clients visible to this API user") + client_id = int(ids[0]) + try: + group_id = client.clients.get_groupid(client_id) + except (PermissionError, NotFoundError): + pytest.skip("client_get_groupid: unavailable") + if not group_id: + pytest.skip("couldn't resolve group id for first visible client") + try: + quota = client.misc.quota_get_by_user(group_id) + except PermissionError: + pytest.skip("quota_get_by_user: admin-only on this panel") + except NotFoundError: + pytest.skip("no quota record for this user") + assert quota is None or isinstance(quota, (list, dict)) diff --git a/tests/test_unit.py b/tests/test_unit.py index 0f30f2b..541b64d 100644 --- a/tests/test_unit.py +++ b/tests/test_unit.py @@ -64,27 +64,34 @@ def test_context_manager_auto_login_logout() -> None: def test_session_expired_retry() -> None: - t = _FakeTransport([ - "sid-first", # login - SoapFault("Server", "Session not valid"), # first _call fails - "sid-second", # re-login - {"domain": "x.com"}, # retry succeeds - ]) + t = _FakeTransport( + [ + "sid-first", # login + SoapFault("Server", "Session not valid"), # first _call fails + "sid-second", # re-login + {"domain": "x.com"}, # retry succeeds + ] + ) c = _make_client(t) c.login() result = c.sites.web_domain_get(1) assert result == {"domain": "x.com"} # 4 transport calls: login, failed get, login, successful get. assert [call[0] for call in t.calls] == [ - "login", "sites_web_domain_get", "login", "sites_web_domain_get", + "login", + "sites_web_domain_get", + "login", + "sites_web_domain_get", ] def test_session_expired_no_retry_when_disabled() -> None: - t = _FakeTransport([ - "sid-first", - SoapFault("Server", "Session expired"), - ]) + t = _FakeTransport( + [ + "sid-first", + SoapFault("Server", "Session expired"), + ] + ) c = ISPConfigClient("http://fake/", "u", "p", max_retries=0) c._transport = t # type: ignore[assignment] c.login() @@ -149,13 +156,13 @@ def test_envelope_encoding_map_and_scalars() -> None: ) assert "abc<" in xml assert '0' in xml - assert 'ns2:Map' in xml + assert "ns2:Map" in xml assert 'php' in xml assert 'fast-cgi' in xml def test_response_parsing_map() -> None: - body = b''' + body = b""" None: -''' +""" result = SoapTransport._parse_response("sites_web_domain_get", body) assert result == {"domain": "mcb.com", "active": "y"} def test_response_parsing_fault() -> None: - body = b''' + body = b""" SOAP-ENV:Server Login failed. -''' +""" with pytest.raises(SoapFault) as excinfo: SoapTransport._parse_response("login", body) assert "Login failed" in excinfo.value.faultstring diff --git a/tools/extract_inventory.py b/tools/extract_inventory.py new file mode 100644 index 0000000..00c0968 --- /dev/null +++ b/tools/extract_inventory.py @@ -0,0 +1,195 @@ +"""Extract ISPConfig remote method inventory from PHP sources. + +Reads every ``remote.d/*.inc.php`` plus ``remoting.inc.php`` and dumps a +structured inventory to ``tools/method_inventory.json``. Parses ``public +function foo($session_id, $bar)`` declarations; scans the preceding lines +for a PHPDoc block to pull param types and descriptions. + +This is the generator's input and a diff target. Checking it in makes +ISPConfig-upgrade deltas trivially visible in git. +""" + +from __future__ import annotations + +import json +import os +import re +import sys +from pathlib import Path +from typing import Any + +# (session_id, ...) for most methods; (username, password) for login. +# ISPConfig sigs look like ``public function foo($session_id, $params = array())`` +# — the ``array()`` default means we need to match balanced parens, not +# ``[^)]*``, or we'll truncate the signature at the first close-paren. We +# also tolerate the opening ``{`` on its own line. +_METHOD_RE = re.compile( + r"^\s*public\s+function\s+(?P\w+)\s*" + r"\((?P(?:[^()]|\([^)]*\))*)\)\s*(?:\n\s*)?\{", + re.MULTILINE, +) +_PARAM_RE = re.compile(r"\$(\w+)(?:\s*=\s*([^,]+))?") + +# Map file basename -> module grouping (for context only; generator re-groups +# by method-name prefix, not by file). +_FILE_CLASS_MAP = { + "sites.inc.php": "sites", + "dns.inc.php": "dns", + "mail.inc.php": "mail", + "client.inc.php": "client", + "server.inc.php": "server", + "monitor.inc.php": "monitor", + "admin.inc.php": "admin", + "aps.inc.php": "aps", + "domains.inc.php": "domains", + "openvz.inc.php": "openvz", + "remoting.inc.php": "core", +} + +# Methods declared on the base ``remoting`` class that aren't "API methods" +# per se — they're internal helpers or lifecycle hooks. We want ``login``, +# ``logout``, and the two ``*_functions`` introspection calls; skip the rest. +_CORE_WHITELIST = { + "login", + "logout", + "get_function_list", + "get_session_token", +} + + +def _find_docblock(lines: list[str], line_no: int) -> str | None: + """Walk backwards from ``line_no`` looking for the closest ``*/`` and + return the enclosing ``/** ... */`` block as raw text, if any.""" + end = None + for i in range(line_no - 1, max(-1, line_no - 60), -1): + stripped = lines[i].strip() + if not stripped: + continue + if stripped.endswith("*/"): + end = i + break + # Non-comment, non-blank: no docblock for this method. + if not stripped.startswith("*") and not stripped.startswith("/*"): + return None + if end is None: + return None + for j in range(end, max(-1, end - 80), -1): + if lines[j].lstrip().startswith("/**") or lines[j].lstrip().startswith("/*"): + return "\n".join(lines[j : end + 1]) + return None + + +def _parse_params(raw: str) -> list[dict[str, Any]]: + """Extract ``$name`` and optional default from a PHP param list.""" + out: list[dict[str, Any]] = [] + for m in _PARAM_RE.finditer(raw): + name = m.group(1) + default = m.group(2).strip() if m.group(2) else None + out.append({"name": name, "default": default}) + return out + + +def _parse_docblock(doc: str | None) -> dict[str, Any]: + if not doc: + return {"summary": None, "params": [], "return": None} + summary_lines: list[str] = [] + params: list[dict[str, str]] = [] + ret = None + for line in doc.splitlines(): + text = line.strip() + if text.startswith("/**") or text.startswith("/*") or text == "*/": + continue + if text.startswith("*"): + text = text[1:].lstrip() + if not text: + continue + if text.startswith("@param"): + # @param int $foo description + m = re.match(r"@param\s+(\S+)\s+\$?(\w+)?\s*(.*)", text) + if m: + params.append( + { + "type": m.group(1), + "name": m.group(2) or "", + "desc": m.group(3), + } + ) + elif text.startswith("@return"): + m = re.match(r"@return\s+(\S+)\s*(.*)", text) + if m: + ret = {"type": m.group(1), "desc": m.group(2)} + elif text.startswith("@"): + # Other tags (@author, @throws, etc.) ignored. + continue + else: + summary_lines.append(text) + return { + "summary": " ".join(summary_lines).strip() or None, + "params": params, + "return": ret, + } + + +def extract_file(path: Path) -> list[dict[str, Any]]: + src = path.read_text(encoding="utf-8", errors="replace") + lines = src.splitlines() + out: list[dict[str, Any]] = [] + for m in _METHOD_RE.finditer(src): + name = m.group("name") + params_raw = m.group("params") + line_no = src[: m.start()].count("\n") + # Parse params. Skip the leading $session_id where present (that's + # the SDK's job to add) — keep it in the raw list so docstrings can + # reflect reality, but flag it. + parsed_params = _parse_params(params_raw) + doc = _find_docblock(lines, line_no) + docinfo = _parse_docblock(doc) + out.append( + { + "method": name, + "file": path.name, + "line": line_no + 1, + "raw_signature": f"{name}({params_raw.strip()})", + "params": parsed_params, + "doc": docinfo, + } + ) + return out + + +def main(src_dir: str, out_path: str) -> None: + root = Path(src_dir) + records: list[dict[str, Any]] = [] + for php in sorted(root.glob("*.inc.php")): + for rec in extract_file(php): + method = rec["method"] + # remoting.inc.php holds login/logout + internal helpers. + if php.name == "remoting.inc.php" and method not in _CORE_WHITELIST: + continue + rec["source_class"] = _FILE_CLASS_MAP.get(php.name, "unknown") + records.append(rec) + # De-dupe by method name (some methods live in multiple files via + # inheritance — take the remote.d/ version). + seen: dict[str, dict[str, Any]] = {} + for rec in records: + if rec["method"] not in seen or rec["file"] != "remoting.inc.php": + seen[rec["method"]] = rec + records = sorted(seen.values(), key=lambda r: (r["source_class"], r["method"])) + Path(out_path).parent.mkdir(parents=True, exist_ok=True) + Path(out_path).write_text(json.dumps(records, indent=2) + "\n", encoding="utf-8") + # Quick stats to stderr so CI logs show what we got. + by_class: dict[str, int] = {} + for rec in records: + by_class[rec["source_class"]] = by_class.get(rec["source_class"], 0) + 1 + print(f"extracted {len(records)} methods", file=sys.stderr) + for cls, n in sorted(by_class.items()): + print(f" {cls:<10} {n}", file=sys.stderr) + + +if __name__ == "__main__": + src = sys.argv[1] if len(sys.argv) > 1 else os.environ.get("ISPCONFIG_SRC", "") + out = sys.argv[2] if len(sys.argv) > 2 else "tools/method_inventory.json" + if not src: + print("usage: extract_inventory.py [out.json]", file=sys.stderr) + sys.exit(2) + main(src, out) diff --git a/tools/gen_methods.py b/tools/gen_methods.py new file mode 100644 index 0000000..4d9541e --- /dev/null +++ b/tools/gen_methods.py @@ -0,0 +1,446 @@ +"""Generate Python wrappers from the ISPConfig method inventory. + +Reads ``tools/method_inventory.json`` and emits/updates one module per +functional area under ``src/ispconfig/``. Each module has two clearly-marked +sections: + + # ---- AUTO-GENERATED START (do not hand-edit above this line) ---- + ... wrappers ... + # ---- AUTO-GENERATED END ---- + # ---- HAND-EDIT ONLY BELOW ---- + ... helpers, convenience methods, etc ... + +Re-running the generator replaces only the auto block; hand-edits below +the delimiter are preserved. Hand-audited helpers already in the tree +(enable_php, a_add with fix_type_bug, user_get with filter-dict +normalization, etc.) live below the delimiter and are untouched. + +If an auto-generated method name collides with a hand-audited one +(detected by scanning the hand-edit block for ``def (``), the +generator skips the auto wrapper — the hand version wins. + +Re-run flow:: + + python3 tools/extract_inventory.py tools/method_inventory.json + python3 tools/gen_methods.py + ruff format src/ tools/ + git diff --stat +""" + +from __future__ import annotations + +import json +import re +import sys +from pathlib import Path +from typing import Any + +ROOT = Path(__file__).resolve().parent.parent +INVENTORY = ROOT / "tools" / "method_inventory.json" +SRC = ROOT / "src" / "ispconfig" + +AUTO_START = "# ---- AUTO-GENERATED START (do not hand-edit above this line) ----" +AUTO_END = "# ---- AUTO-GENERATED END ----" +HAND_MARKER = "# ---- HAND-EDIT ONLY BELOW ----" + +# Routing: method-name prefix -> (module filename, class name, method-name +# stripping rule). The stripping rule strips a prefix from the Python method +# name when we can keep it; we don't, for auto-generated wrappers, so the +# generator emits ``method_foo_bar`` as-is. (Hand-audited helpers strip the +# prefix for ergonomics — kept below the delimiter.) +# +# Order matters: first match wins. Longer prefixes first. +_ROUTES: list[tuple[str, str, str]] = [ + # sites.* + ("sites_web_vhost_aliasdomain_", "sites.py", "SitesModule"), + ("sites_web_vhost_subdomain_", "sites.py", "SitesModule"), + ("sites_web_aliasdomain_", "sites.py", "SitesModule"), + ("sites_web_subdomain_", "sites.py", "SitesModule"), + ("sites_web_domain_backup", "backups.py", "BackupsModule"), + ("sites_web_domain_", "sites.py", "SitesModule"), + ("sites_web_folder_user_", "sites.py", "SitesModule"), + ("sites_web_folder_", "sites.py", "SitesModule"), + ("sites_database_user_", "databases.py", "DatabasesModule"), + ("sites_database_", "databases.py", "DatabasesModule"), + ("sites_ftp_user_", "ftp.py", "FtpModule"), + ("sites_shell_user_", "shell.py", "ShellModule"), + ("sites_cron_", "cron.py", "CronModule"), + ("sites_webdav_user_", "webdav.py", "WebdavModule"), + ("sites_aps_", "aps.py", "ApsModule"), + ("client_", "clients.py", "ClientsModule"), + ("mail_", "mail.py", "MailModule"), + ("mailquota_", "mail.py", "MailModule"), + ("dns_", "dns.py", "DnsModule"), + ("server_", "server.py", "ServerModule"), + ("monitor_", "monitor.py", "MonitorModule"), + ("domains_", "domains.py", "DomainsModule"), + ("openvz_", "openvz.py", "OpenvzModule"), + # admin / misc buckets + ("sys_datalog_", "admin.py", "AdminModule"), + ("system_config_", "admin.py", "AdminModule"), + ("config_value_", "admin.py", "AdminModule"), + ("update_record_permissions", "admin.py", "AdminModule"), + # quotas and misc helpers from sites.inc.php that don't match the + # `sites_*` prefix + ("quota_get_by_user", "misc.py", "MiscModule"), + ("databasequota_get_by_user", "misc.py", "MiscModule"), + ("ftptrafficquota_data", "misc.py", "MiscModule"), + ("trafficquota_get_by_user", "misc.py", "MiscModule"), + ("client_get_sites_by_user", "misc.py", "MiscModule"), +] + +# Modules that already exist in the tree with a hand-audited class. For +# these, we append the auto block to an existing class body rather than +# writing a fresh module. +_PREEXISTING = { + "sites.py": "SitesModule", + "dns.py": "DnsModule", + "mail.py": "MailModule", + "databases.py": "DatabasesModule", + "clients.py": "ClientsModule", +} + +# Methods we skip at generation time: ``login`` and ``logout`` are already +# on the top-level client, and ``get_function_list`` is a no-arg +# introspection call we expose via ``ISPConfigClient.list_functions()``. +_SKIP_METHODS = {"login", "logout", "get_function_list"} + + +def route(method: str) -> tuple[str, str] | None: + for prefix, fname, cls in _ROUTES: + if method == prefix or method.startswith(prefix): + return fname, cls + return None + + +def _py_method_name(method: str, prefix: str) -> str: + """Strip the routed prefix from a method name if it's safe to. + + For the auto-generated wrappers we keep the full PHP method name as + the Python method name. This is verbose but unambiguous — and matches + ``raw_call`` semantics so you can grep for the exact PHP string. + + Hand-audited helpers may provide shorter names; they live below the + delimiter and take precedence. + """ + return method # keep the full PHP name; stripping invites collisions + + +def _docstring(rec: dict[str, Any]) -> list[str]: + """Return docstring lines, indented with 8 spaces (method-body level).""" + indent = " " + lines = [f'{indent}"""'] + summary = rec["doc"].get("summary") or f"Auto-generated wrapper for ``{rec['method']}``." + # Escape embedded triple quotes defensively. + summary = summary.replace('"""', "'''") + lines.append(f"{indent}{summary}") + lines.append("") + lines.append(f"{indent}Source: ``{rec['file']}`` line {rec['line']}.") + sig_params = [p["name"] for p in rec["params"] if p["name"] != "session_id"] + if sig_params: + lines.append(f"{indent}PHP signature: ``{rec['raw_signature']}``.") + if rec["doc"]["params"]: + lines.append("") + lines.append(f"{indent}Params (from PHPDoc):") + for p in rec["doc"]["params"]: + pname = p.get("name") or "?" + if pname == "session_id": + continue + ptype = p.get("type", "?") + desc = (p.get("desc") or "").replace('"""', "'''") + if desc: + lines.append(f"{indent} {pname} ({ptype}): {desc}") + else: + lines.append(f"{indent} {pname} ({ptype})") + if rec["doc"].get("return"): + lines.append("") + ret_type = rec["doc"]["return"].get("type", "Any") + ret_desc = (rec["doc"]["return"].get("desc") or "").replace('"""', "'''") + suffix = f" - {ret_desc}" if ret_desc else "" + lines.append(f"{indent}Returns: {ret_type}{suffix}") + lines.append("") + lines.append(f"{indent}AUTO-GENERATED - param shapes may need verification against your") + lines.append(f"{indent}ISPConfig version. File issues at Sulkta-Coop/ispconfig-py.") + lines.append(f'{indent}"""') + return lines + + +_PHP_TYPE_MAP = { + "int": "int", + "integer": "int", + "string": "str", + "bool": "bool", + "boolean": "bool", + "array": "dict[str, Any] | list[Any]", + "mixed": "Any", + "float": "float", + "double": "float", +} + + +def _py_param_type(phpdoc_params: list[dict[str, str]], name: str) -> str: + for p in phpdoc_params: + if p.get("name") == name: + t = (p.get("type") or "").strip().lower().split("|")[0] + return _PHP_TYPE_MAP.get(t, "Any") + return "Any" + + +def _emit_method(rec: dict[str, Any]) -> list[str]: + method = rec["method"] + # Parameters after session_id. + params = [p for p in rec["params"] if p["name"] != "session_id"] + sig_parts = ["self"] + arg_encodes: list[str] = [] + for p in params: + py_type = _py_param_type(rec["doc"]["params"], p["name"]) + default = p["default"] + if default is not None: + # PHP defaults are best-effort translated. + default_py = _translate_php_default(default) + # PEP 484: a None default needs ``| None`` on the annotation. + # Any already includes None, so no change needed for Any. + if default_py == "None" and py_type not in ("Any", "dict[str, Any] | list[Any]"): + py_type = f"{py_type} | None" + sig_parts.append(f"{p['name']}: {py_type} = {default_py}") + else: + sig_parts.append(f"{p['name']}: {py_type}") + arg_encodes.append(f'("{p["name"]}", {p["name"]})') + signature = ", ".join(sig_parts) + lines: list[str] = [] + lines.append(f" def {method}({signature}) -> Any:") + lines.extend(_docstring(rec)) + if arg_encodes: + args_str = ", ".join(arg_encodes) + lines.append(f' return self._c._call("{method}", {args_str})') + else: + lines.append(f' return self._c._call("{method}")') + lines.append("") + return lines + + +def _translate_php_default(value: str) -> str: + v = value.strip() + low = v.lower() + if low in ("null",): + return "None" + if low == "true": + return "True" + if low == "false": + return "False" + if low in ("array()", "[]"): + return "None" # PHP empty-array default -> None in Python signature + # Numeric literals pass through. + if re.match(r"^-?\d+(\.\d+)?$", v): + return v + # Quoted strings. + if (v.startswith("'") and v.endswith("'")) or (v.startswith('"') and v.endswith('"')): + inner = v[1:-1] + return '"' + inner.replace("\\", "\\\\").replace('"', '\\"') + '"' + # Unknown → fall back to None (safest default for optional params). + return "None" + + +# ----------------------------------------------------------------------- +# Module file handling +# ----------------------------------------------------------------------- + + +def _module_header(fname: str, cls: str) -> str: + """Stock module header for NEW module files (not preexisting).""" + stem = fname.replace(".py", "") + mod_title = stem.replace("_", " ").title() + return ( + f'"""``{stem}.*`` — auto-generated ISPConfig remote-API wrappers.\n\n' + f"This module is produced by ``tools/gen_methods.py`` from the\n" + f"``tools/method_inventory.json`` catalog. Hand-edits go below the\n" + f"``{HAND_MARKER.strip('# ')}`` marker — they survive regeneration.\n" + f'"""\n\n' + f"from __future__ import annotations\n\n" + f"from typing import TYPE_CHECKING, Any\n\n" + f"if TYPE_CHECKING:\n" + f" from .client import ISPConfigClient\n\n\n" + f"class {cls}:\n" + f' """Auto-generated module: {mod_title}.\n\n' + f" All methods below the ``AUTO-GENERATED START`` marker are produced\n" + f" by ``tools/gen_methods.py``. Do not hand-edit that block — changes\n" + f" will be overwritten on the next regeneration. Add helpers and\n" + f" overrides below the ``HAND-EDIT ONLY BELOW`` marker instead.\n" + f' """\n\n' + f" def __init__(self, client: ISPConfigClient) -> None:\n" + f" self._c = client\n\n" + ) + + +def _find_existing_auto_block(text: str) -> tuple[int, int] | None: + """Return (start_line_idx, end_line_idx) of the existing auto block, if any.""" + lines = text.splitlines() + start = end = None + for i, line in enumerate(lines): + if AUTO_START in line: + start = i + if AUTO_END in line and start is not None: + end = i + break + if start is None or end is None: + return None + return start, end + + +def _find_class_body_insertion(text: str, cls: str) -> int | None: + """Find the line index of the first blank line AFTER the class's __init__ + (a sensible spot to inject the auto block in a preexisting module). + """ + lines = text.splitlines() + in_class = False + saw_init = False + for i, line in enumerate(lines): + if re.match(rf"class\s+{cls}\b", line): + in_class = True + continue + if in_class and "def __init__" in line: + saw_init = True + if saw_init and line.strip() == "": + return i + 1 + return None + + +def _extract_hand_method_names(text: str, auto_end: int | None) -> set[str]: + """Scan everything AFTER the auto block for ``def (`` so the + generator can skip methods a hand-audited helper already claims. + """ + lines = text.splitlines() + start = (auto_end + 1) if auto_end is not None else 0 + names: set[str] = set() + for line in lines[start:]: + m = re.match(r"\s+def\s+(\w+)\s*\(", line) + if m: + names.add(m.group(1)) + return names + + +def _render_auto_block(records: list[dict[str, Any]], hand_names: set[str]) -> list[str]: + lines: list[str] = [] + lines.append(f" {AUTO_START}") + lines.append(" # Regenerate with: python3 tools/gen_methods.py") + lines.append("") + emitted_names: set[str] = set() + for rec in sorted(records, key=lambda r: r["method"]): + if rec["method"] in hand_names: + lines.append(f" # skipped {rec['method']}: hand-audited helper below takes precedence") + lines.append("") + continue + if rec["method"] in emitted_names: + continue + emitted_names.add(rec["method"]) + lines.extend(_emit_method(rec)) + lines.append(f" {AUTO_END}") + lines.append("") + lines.append(f" {HAND_MARKER}") + lines.append("") + return lines + + +def _ensure_any_imported(text: str) -> str: + """Make sure ``Any`` is imported from ``typing`` — auto-generated wrappers + always need it. Leaves other imports untouched; idempotent. + """ + if re.search(r"^from\s+typing\s+import[^\n]*\bAny\b", text, re.MULTILINE): + return text + m = re.search(r"^(from\s+typing\s+import\s+)([^\n]+)$", text, re.MULTILINE) + if m: + current = m.group(2) + # Append ``Any``; keep symbols sorted lexically for stable diffs. + symbols = sorted({s.strip() for s in current.split(",")} | {"Any"}) + new_line = m.group(1) + ", ".join(symbols) + return text[: m.start()] + new_line + text[m.end() :] + # No ``from typing import`` at all — add one after ``from __future__``. + fut = re.search(r"^from\s+__future__\s+import[^\n]*$", text, re.MULTILINE) + if fut: + insertion = fut.end() + return text[:insertion] + "\n\nfrom typing import Any" + text[insertion:] + # Last resort: prepend. + return "from typing import Any\n\n" + text + + +def _update_existing_module(path: Path, cls: str, records: list[dict[str, Any]]) -> None: + text = path.read_text(encoding="utf-8") + text = _ensure_any_imported(text) + block = _find_existing_auto_block(text) + if block is None: + # First-time injection: find where to insert. + lines = text.splitlines() + insertion = _find_class_body_insertion(text, cls) + if insertion is None: + print(f"WARN: couldn't find insertion point in {path}", file=sys.stderr) + return + hand_names = _extract_hand_method_names(text, auto_end=None) + auto_lines = _render_auto_block(records, hand_names) + new_lines = lines[:insertion] + auto_lines + lines[insertion:] + path.write_text("\n".join(new_lines).rstrip() + "\n", encoding="utf-8") + return + start, end = block + lines = text.splitlines() + hand_names = _extract_hand_method_names(text, auto_end=end) + auto_lines = _render_auto_block(records, hand_names) + # Replace start..end+possible trailing hand-marker line; we also re-emit the + # hand marker so we own its exact placement. Consume any blank lines plus + # a HAND_MARKER (with optional trailing blank) between AUTO_END and the + # first real code below — we'll re-emit the marker ourselves at the end + # of ``auto_lines``. + after = end + 1 + while after < len(lines) and lines[after].strip() == "": + after += 1 + if after < len(lines) and HAND_MARKER in lines[after]: + after += 1 + while after < len(lines) and lines[after].strip() == "": + after += 1 + new_lines = lines[:start] + auto_lines + lines[after:] + path.write_text("\n".join(new_lines).rstrip() + "\n", encoding="utf-8") + + +def _write_new_module(path: Path, cls: str, records: list[dict[str, Any]]) -> None: + header = _module_header(path.name, cls) + auto_lines = _render_auto_block(records, hand_names=set()) + body = header + "\n".join(auto_lines).rstrip() + "\n" + path.write_text(body, encoding="utf-8") + + +def main() -> None: + records = json.loads(INVENTORY.read_text(encoding="utf-8")) + SRC.mkdir(parents=True, exist_ok=True) + + by_module: dict[tuple[str, str], list[dict[str, Any]]] = {} + unrouted: list[str] = [] + for rec in records: + if rec["method"] in _SKIP_METHODS: + continue + routed = route(rec["method"]) + if routed is None: + unrouted.append(rec["method"]) + # Default bucket = misc.py + routed = ("misc.py", "MiscModule") + key = routed + by_module.setdefault(key, []).append(rec) + + for (fname, cls), recs in sorted(by_module.items()): + path = SRC / fname + if path.exists() and fname in _PREEXISTING: + _update_existing_module(path, cls, recs) + action = "updated" + elif path.exists(): + _update_existing_module(path, cls, recs) + action = "refreshed" + else: + _write_new_module(path, cls, recs) + action = "created" + print(f"{action:<10} {fname:<16} ({len(recs)} methods)") + + if unrouted: + print(f"\nUNROUTED ({len(unrouted)}) — filed under misc.py:", file=sys.stderr) + for m in unrouted: + print(f" {m}", file=sys.stderr) + + +if __name__ == "__main__": + main() diff --git a/tools/method_inventory.json b/tools/method_inventory.json new file mode 100644 index 0000000..5f0fdf6 --- /dev/null +++ b/tools/method_inventory.json @@ -0,0 +1,8284 @@ +[ + { + "method": "config_value_add", + "file": "admin.inc.php", + "line": 181, + "raw_signature": "config_value_add($session_id, $group, $name, $value)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "group", + "default": null + }, + { + "name": "name", + "default": null + }, + { + "name": "value", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "admin" + }, + { + "method": "config_value_delete", + "file": "admin.inc.php", + "line": 252, + "raw_signature": "config_value_delete($session_id, $group, $name)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "group", + "default": null + }, + { + "name": "name", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "admin" + }, + { + "method": "config_value_get", + "file": "admin.inc.php", + "line": 162, + "raw_signature": "config_value_get($session_id, $group, $name)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "group", + "default": null + }, + { + "name": "name", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "admin" + }, + { + "method": "config_value_replace", + "file": "admin.inc.php", + "line": 229, + "raw_signature": "config_value_replace($session_id, $group, $name, $value)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "group", + "default": null + }, + { + "name": "name", + "default": null + }, + { + "name": "value", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "admin" + }, + { + "method": "config_value_update", + "file": "admin.inc.php", + "line": 205, + "raw_signature": "config_value_update($session_id, $group, $name, $value)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "group", + "default": null + }, + { + "name": "name", + "default": null + }, + { + "name": "value", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "admin" + }, + { + "method": "sys_datalog_get", + "file": "admin.inc.php", + "line": 294, + "raw_signature": "sys_datalog_get($session_id, $datalog_id, $newer = false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "datalog_id", + "default": null + }, + { + "name": "newer", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "admin" + }, + { + "method": "sys_datalog_get_by_tstamp", + "file": "admin.inc.php", + "line": 276, + "raw_signature": "sys_datalog_get_by_tstamp($session_id, $tstamp)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "tstamp", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "admin" + }, + { + "method": "system_config_get", + "file": "admin.inc.php", + "line": 137, + "raw_signature": "system_config_get($session_id, $section, $key = null)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "section", + "default": null + }, + { + "name": "key", + "default": "null" + } + ], + "doc": { + "summary": "Get the values of the system configuration", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "string", + "name": "section", + "desc": "of the config field in the table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc" + }, + { + "type": "string|null", + "name": "key", + "desc": "of the option that you want to get" + } + ], + "return": null + }, + "source_class": "admin" + }, + { + "method": "system_config_set", + "file": "admin.inc.php", + "line": 113, + "raw_signature": "system_config_set($session_id, $section, $key, $value)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "section", + "default": null + }, + { + "name": "key", + "default": null + }, + { + "name": "value", + "default": null + } + ], + "doc": { + "summary": "Set a value in the system configuration", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "string", + "name": "section", + "desc": "of the config field in the table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc" + }, + { + "type": "string", + "name": "key", + "desc": "of the option that you want to set" + }, + { + "type": "string", + "name": "option", + "desc": "value that you want to set" + } + ], + "return": null + }, + "source_class": "admin" + }, + { + "method": "update_record_permissions", + "file": "admin.inc.php", + "line": 51, + "raw_signature": "update_record_permissions($session_id, $tablename, $index_field, $index_value, $permissions)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "tablename", + "default": null + }, + { + "name": "index_field", + "default": null + }, + { + "name": "index_value", + "default": null + }, + { + "name": "permissions", + "default": null + } + ], + "doc": { + "summary": "set record permissions in any table", + "params": [ + { + "type": "string", + "name": "session_id", + "desc": "" + }, + { + "type": "string", + "name": "index_field", + "desc": "" + }, + { + "type": "string", + "name": "index_value", + "desc": "" + }, + { + "type": "array", + "name": "permissions", + "desc": "" + } + ], + "return": null + }, + "source_class": "admin" + }, + { + "method": "sites_aps_available_packages_list", + "file": "aps.inc.php", + "line": 56, + "raw_signature": "sites_aps_available_packages_list($session_id, $params = array())", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "params", + "default": "array()" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_change_package_status", + "file": "aps.inc.php", + "line": 201, + "raw_signature": "sites_aps_change_package_status($session_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_get_package_details", + "file": "aps.inc.php", + "line": 78, + "raw_signature": "sites_aps_get_package_details($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_get_package_file", + "file": "aps.inc.php", + "line": 118, + "raw_signature": "sites_aps_get_package_file($session_id, $primary_id, $filename)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "filename", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_get_package_settings", + "file": "aps.inc.php", + "line": 163, + "raw_signature": "sites_aps_get_package_settings($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_install_package", + "file": "aps.inc.php", + "line": 231, + "raw_signature": "sites_aps_install_package($session_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_instance_delete", + "file": "aps.inc.php", + "line": 331, + "raw_signature": "sites_aps_instance_delete($session_id, $primary_id, $params = array())", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": "array()" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_instance_get", + "file": "aps.inc.php", + "line": 303, + "raw_signature": "sites_aps_instance_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_instance_settings_get", + "file": "aps.inc.php", + "line": 317, + "raw_signature": "sites_aps_instance_settings_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "sites_aps_update_package_list", + "file": "aps.inc.php", + "line": 38, + "raw_signature": "sites_aps_update_package_list($session_id)", + "params": [ + { + "name": "session_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "aps" + }, + { + "method": "client_add", + "file": "client.inc.php", + "line": 157, + "raw_signature": "client_add($session_id, $reseller_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "reseller_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_change_password", + "file": "client.inc.php", + "line": 537, + "raw_signature": "client_change_password($session_id, $client_id, $new_password)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "new_password", + "default": null + } + ], + "doc": { + "summary": "Changes client password", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "client", + "desc": "id" + }, + { + "type": "string", + "name": "new", + "desc": "password" + } + ], + "return": { + "type": "bool", + "desc": "true if success" + } + }, + "source_class": "client" + }, + { + "method": "client_delete", + "file": "client.inc.php", + "line": 372, + "raw_signature": "client_delete($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_delete_everything", + "file": "client.inc.php", + "line": 390, + "raw_signature": "client_delete_everything($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_get", + "file": "client.inc.php", + "line": 51, + "raw_signature": "client_get($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_get_all", + "file": "client.inc.php", + "line": 512, + "raw_signature": "client_get_all($session_id)", + "params": [ + { + "name": "session_id", + "default": null + } + ], + "doc": { + "summary": "Get All client_id's from database", + "params": [ + { + "type": "int", + "name": "session_id", + "desc": "" + } + ], + "return": { + "type": "Array", + "desc": "of all client_id's" + } + }, + "source_class": "client" + }, + { + "method": "client_get_by_customer_no", + "file": "client.inc.php", + "line": 485, + "raw_signature": "client_get_by_customer_no($session_id, $customer_no)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "customer_no", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_get_by_groupid", + "file": "client.inc.php", + "line": 688, + "raw_signature": "client_get_by_groupid($session_id, $group_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "group_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_get_by_username", + "file": "client.inc.php", + "line": 469, + "raw_signature": "client_get_by_username($session_id, $username)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "username", + "default": null + } + ], + "doc": { + "summary": "Get sys_user information by username", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "string", + "name": "user", + "desc": "'s name" + } + ], + "return": { + "type": "mixed", + "desc": "false if error" + } + }, + "source_class": "client" + }, + { + "method": "client_get_emailcontact", + "file": "client.inc.php", + "line": 118, + "raw_signature": "client_get_emailcontact($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_get_groupid", + "file": "client.inc.php", + "line": 137, + "raw_signature": "client_get_groupid($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_get_id", + "file": "client.inc.php", + "line": 96, + "raw_signature": "client_get_id($session_id, $sys_userid)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "sys_userid", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_login_get", + "file": "client.inc.php", + "line": 576, + "raw_signature": "client_login_get($session_id,$username,$password,$remote_ip = '')", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "username", + "default": null + }, + { + "name": "password", + "default": null + }, + { + "name": "remote_ip", + "default": "''" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_template_additional_add", + "file": "client.inc.php", + "line": 296, + "raw_signature": "client_template_additional_add($session_id, $client_id, $template_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "template_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_template_additional_delete", + "file": "client.inc.php", + "line": 334, + "raw_signature": "client_template_additional_delete($session_id, $client_id, $assigned_template_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "assigned_template_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_template_additional_get", + "file": "client.inc.php", + "line": 258, + "raw_signature": "client_template_additional_get($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_templates_get_all", + "file": "client.inc.php", + "line": 566, + "raw_signature": "client_templates_get_all($session_id)", + "params": [ + { + "name": "session_id", + "default": null + } + ], + "doc": { + "summary": "Get all client templates", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + } + ], + "return": null + }, + "source_class": "client" + }, + { + "method": "client_update", + "file": "client.inc.php", + "line": 187, + "raw_signature": "client_update($session_id, $client_id, $reseller_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "reseller_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "client" + }, + { + "method": "get_function_list", + "file": "remoting.inc.php", + "line": 683, + "raw_signature": "get_function_list($session_id)", + "params": [ + { + "name": "session_id", + "default": null + } + ], + "doc": { + "summary": "Get a list of functions", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + } + ], + "return": { + "type": "mixed", + "desc": "array of the available functions" + } + }, + "source_class": "core" + }, + { + "method": "login", + "file": "remoting.inc.php", + "line": 65, + "raw_signature": "login($username, $password, $client_login = false)", + "params": [ + { + "name": "username", + "default": null + }, + { + "name": "password", + "default": null + }, + { + "name": "client_login", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "core" + }, + { + "method": "logout", + "file": "remoting.inc.php", + "line": 248, + "raw_signature": "logout($session_id)", + "params": [ + { + "name": "session_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "core" + }, + { + "method": "dns_a_add", + "file": "dns.inc.php", + "line": 292, + "raw_signature": "dns_a_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_a_delete", + "file": "dns.inc.php", + "line": 302, + "raw_signature": "dns_a_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_a_get", + "file": "dns.inc.php", + "line": 287, + "raw_signature": "dns_a_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_a_update", + "file": "dns.inc.php", + "line": 297, + "raw_signature": "dns_a_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_aaaa_add", + "file": "dns.inc.php", + "line": 270, + "raw_signature": "dns_aaaa_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_aaaa_delete", + "file": "dns.inc.php", + "line": 280, + "raw_signature": "dns_aaaa_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_aaaa_get", + "file": "dns.inc.php", + "line": 265, + "raw_signature": "dns_aaaa_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_aaaa_update", + "file": "dns.inc.php", + "line": 275, + "raw_signature": "dns_aaaa_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_alias_add", + "file": "dns.inc.php", + "line": 314, + "raw_signature": "dns_alias_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_alias_delete", + "file": "dns.inc.php", + "line": 324, + "raw_signature": "dns_alias_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_alias_get", + "file": "dns.inc.php", + "line": 309, + "raw_signature": "dns_alias_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_alias_update", + "file": "dns.inc.php", + "line": 319, + "raw_signature": "dns_alias_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_caa_add", + "file": "dns.inc.php", + "line": 336, + "raw_signature": "dns_caa_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_caa_delete", + "file": "dns.inc.php", + "line": 346, + "raw_signature": "dns_caa_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_caa_get", + "file": "dns.inc.php", + "line": 331, + "raw_signature": "dns_caa_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_caa_update", + "file": "dns.inc.php", + "line": 341, + "raw_signature": "dns_caa_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_cname_add", + "file": "dns.inc.php", + "line": 358, + "raw_signature": "dns_cname_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_cname_delete", + "file": "dns.inc.php", + "line": 368, + "raw_signature": "dns_cname_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_cname_get", + "file": "dns.inc.php", + "line": 353, + "raw_signature": "dns_cname_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_cname_update", + "file": "dns.inc.php", + "line": 363, + "raw_signature": "dns_cname_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_dname_add", + "file": "dns.inc.php", + "line": 380, + "raw_signature": "dns_dname_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_dname_delete", + "file": "dns.inc.php", + "line": 390, + "raw_signature": "dns_dname_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_dname_get", + "file": "dns.inc.php", + "line": 375, + "raw_signature": "dns_dname_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_dname_update", + "file": "dns.inc.php", + "line": 385, + "raw_signature": "dns_dname_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ds_add", + "file": "dns.inc.php", + "line": 513, + "raw_signature": "dns_ds_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ds_delete", + "file": "dns.inc.php", + "line": 523, + "raw_signature": "dns_ds_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ds_get", + "file": "dns.inc.php", + "line": 508, + "raw_signature": "dns_ds_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ds_update", + "file": "dns.inc.php", + "line": 518, + "raw_signature": "dns_ds_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_hinfo_add", + "file": "dns.inc.php", + "line": 402, + "raw_signature": "dns_hinfo_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_hinfo_delete", + "file": "dns.inc.php", + "line": 412, + "raw_signature": "dns_hinfo_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_hinfo_get", + "file": "dns.inc.php", + "line": 397, + "raw_signature": "dns_hinfo_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_hinfo_update", + "file": "dns.inc.php", + "line": 407, + "raw_signature": "dns_hinfo_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_loc_add", + "file": "dns.inc.php", + "line": 425, + "raw_signature": "dns_loc_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_loc_delete", + "file": "dns.inc.php", + "line": 435, + "raw_signature": "dns_loc_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_loc_get", + "file": "dns.inc.php", + "line": 420, + "raw_signature": "dns_loc_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_loc_update", + "file": "dns.inc.php", + "line": 430, + "raw_signature": "dns_loc_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_mx_add", + "file": "dns.inc.php", + "line": 447, + "raw_signature": "dns_mx_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_mx_delete", + "file": "dns.inc.php", + "line": 457, + "raw_signature": "dns_mx_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_mx_get", + "file": "dns.inc.php", + "line": 442, + "raw_signature": "dns_mx_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_mx_update", + "file": "dns.inc.php", + "line": 452, + "raw_signature": "dns_mx_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_naptr_add", + "file": "dns.inc.php", + "line": 469, + "raw_signature": "dns_naptr_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_naptr_delete", + "file": "dns.inc.php", + "line": 479, + "raw_signature": "dns_naptr_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_naptr_get", + "file": "dns.inc.php", + "line": 464, + "raw_signature": "dns_naptr_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_naptr_update", + "file": "dns.inc.php", + "line": 474, + "raw_signature": "dns_naptr_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ns_add", + "file": "dns.inc.php", + "line": 491, + "raw_signature": "dns_ns_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ns_delete", + "file": "dns.inc.php", + "line": 501, + "raw_signature": "dns_ns_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ns_get", + "file": "dns.inc.php", + "line": 486, + "raw_signature": "dns_ns_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ns_update", + "file": "dns.inc.php", + "line": 496, + "raw_signature": "dns_ns_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ptr_add", + "file": "dns.inc.php", + "line": 535, + "raw_signature": "dns_ptr_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ptr_delete", + "file": "dns.inc.php", + "line": 545, + "raw_signature": "dns_ptr_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ptr_get", + "file": "dns.inc.php", + "line": 530, + "raw_signature": "dns_ptr_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_ptr_update", + "file": "dns.inc.php", + "line": 540, + "raw_signature": "dns_ptr_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_rp_add", + "file": "dns.inc.php", + "line": 557, + "raw_signature": "dns_rp_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_rp_delete", + "file": "dns.inc.php", + "line": 567, + "raw_signature": "dns_rp_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_rp_get", + "file": "dns.inc.php", + "line": 552, + "raw_signature": "dns_rp_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_rp_update", + "file": "dns.inc.php", + "line": 562, + "raw_signature": "dns_rp_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_rr_get_all_by_zone", + "file": "dns.inc.php", + "line": 707, + "raw_signature": "dns_rr_get_all_by_zone($session_id, $zone_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "zone_id", + "default": null + } + ], + "doc": { + "summary": "Get all dns records for a zone", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "dns", + "desc": "zone id" + } + ], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_slave_add", + "file": "dns.inc.php", + "line": 114, + "raw_signature": "dns_slave_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_slave_delete", + "file": "dns.inc.php", + "line": 133, + "raw_signature": "dns_slave_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_slave_get", + "file": "dns.inc.php", + "line": 100, + "raw_signature": "dns_slave_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_slave_update", + "file": "dns.inc.php", + "line": 123, + "raw_signature": "dns_slave_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_srv_add", + "file": "dns.inc.php", + "line": 579, + "raw_signature": "dns_srv_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_srv_delete", + "file": "dns.inc.php", + "line": 589, + "raw_signature": "dns_srv_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_srv_get", + "file": "dns.inc.php", + "line": 574, + "raw_signature": "dns_srv_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_srv_update", + "file": "dns.inc.php", + "line": 584, + "raw_signature": "dns_srv_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_sshfp_add", + "file": "dns.inc.php", + "line": 601, + "raw_signature": "dns_sshfp_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_sshfp_delete", + "file": "dns.inc.php", + "line": 611, + "raw_signature": "dns_sshfp_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_sshfp_get", + "file": "dns.inc.php", + "line": 596, + "raw_signature": "dns_sshfp_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_sshfp_update", + "file": "dns.inc.php", + "line": 606, + "raw_signature": "dns_sshfp_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_templatezone_add", + "file": "dns.inc.php", + "line": 45, + "raw_signature": "dns_templatezone_add($session_id, $client_id, $template_id, $domain, $ip, $ns1, $ns2, $email, $ipv6 = '')", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "template_id", + "default": null + }, + { + "name": "domain", + "default": null + }, + { + "name": "ip", + "default": null + }, + { + "name": "ns1", + "default": null + }, + { + "name": "ns2", + "default": null + }, + { + "name": "email", + "default": null + }, + { + "name": "ipv6", + "default": "''" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_templatezone_get_all", + "file": "dns.inc.php", + "line": 684, + "raw_signature": "dns_templatezone_get_all($session_id)", + "params": [ + { + "name": "session_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_tlsa_add", + "file": "dns.inc.php", + "line": 623, + "raw_signature": "dns_tlsa_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_tlsa_delete", + "file": "dns.inc.php", + "line": 633, + "raw_signature": "dns_tlsa_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_tlsa_get", + "file": "dns.inc.php", + "line": 618, + "raw_signature": "dns_tlsa_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_tlsa_update", + "file": "dns.inc.php", + "line": 628, + "raw_signature": "dns_tlsa_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_txt_add", + "file": "dns.inc.php", + "line": 645, + "raw_signature": "dns_txt_add($session_id, $client_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_txt_delete", + "file": "dns.inc.php", + "line": 655, + "raw_signature": "dns_txt_delete($session_id, $primary_id, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_txt_get", + "file": "dns.inc.php", + "line": 640, + "raw_signature": "dns_txt_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_txt_update", + "file": "dns.inc.php", + "line": 650, + "raw_signature": "dns_txt_update($session_id, $client_id, $primary_id, $params, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_add", + "file": "dns.inc.php", + "line": 165, + "raw_signature": "dns_zone_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_delete", + "file": "dns.inc.php", + "line": 184, + "raw_signature": "dns_zone_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_get", + "file": "dns.inc.php", + "line": 87, + "raw_signature": "dns_zone_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_get_by_user", + "file": "dns.inc.php", + "line": 663, + "raw_signature": "dns_zone_get_by_user($session_id, $client_id, $server_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "server_id", + "default": null + } + ], + "doc": { + "summary": "Get all DNS zone by user", + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_get_id", + "file": "dns.inc.php", + "line": 142, + "raw_signature": "dns_zone_get_id($session_id, $origin)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "origin", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_set_dnssec", + "file": "dns.inc.php", + "line": 757, + "raw_signature": "dns_zone_set_dnssec($session_id, $client_id, $primary_id, $algo, $update_serial=false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "algo", + "default": null + }, + { + "name": "update_serial", + "default": "false" + } + ], + "doc": { + "summary": "Set DNSSec Algo and activate it if needed.", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "client", + "desc": "id" + }, + { + "type": "string", + "name": "algorithm", + "desc": "'NSEC3RSASHA1', 'ECDSAP256SHA256' or 'NSEC3RSASHA1,ECDSAP256SHA256' string" + }, + { + "type": "boolean", + "name": "update", + "desc": "serial" + } + ], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_set_status", + "file": "dns.inc.php", + "line": 725, + "raw_signature": "dns_zone_set_status($session_id, $primary_id, $status)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "status", + "default": null + } + ], + "doc": { + "summary": "Changes DNS zone status", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "dns", + "desc": "soa id" + }, + { + "type": "string", + "name": "status", + "desc": "active or inactive string" + } + ], + "return": null + }, + "source_class": "dns" + }, + { + "method": "dns_zone_update", + "file": "dns.inc.php", + "line": 174, + "raw_signature": "dns_zone_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "dns" + }, + { + "method": "domains_domain_add", + "file": "domains.inc.php", + "line": 59, + "raw_signature": "domains_domain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "domains" + }, + { + "method": "domains_domain_delete", + "file": "domains.inc.php", + "line": 79, + "raw_signature": "domains_domain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "domains" + }, + { + "method": "domains_domain_get", + "file": "domains.inc.php", + "line": 45, + "raw_signature": "domains_domain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "domains" + }, + { + "method": "domains_domain_update", + "file": "domains.inc.php", + "line": 69, + "raw_signature": "domains_domain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "domains" + }, + { + "method": "domains_get_all_by_user", + "file": "domains.inc.php", + "line": 90, + "raw_signature": "domains_get_all_by_user($session_id, $group_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "group_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "domains" + }, + { + "method": "mail_alias_add", + "file": "mail.inc.php", + "line": 424, + "raw_signature": "mail_alias_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_alias_delete", + "file": "mail.inc.php", + "line": 466, + "raw_signature": "mail_alias_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_alias_get", + "file": "mail.inc.php", + "line": 410, + "raw_signature": "mail_alias_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_alias_update", + "file": "mail.inc.php", + "line": 444, + "raw_signature": "mail_alias_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_aliasdomain_add", + "file": "mail.inc.php", + "line": 111, + "raw_signature": "mail_aliasdomain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_aliasdomain_delete", + "file": "mail.inc.php", + "line": 133, + "raw_signature": "mail_aliasdomain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_aliasdomain_get", + "file": "mail.inc.php", + "line": 97, + "raw_signature": "mail_aliasdomain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_aliasdomain_update", + "file": "mail.inc.php", + "line": 121, + "raw_signature": "mail_aliasdomain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_blacklist_add", + "file": "mail.inc.php", + "line": 1040, + "raw_signature": "mail_blacklist_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_blacklist_delete", + "file": "mail.inc.php", + "line": 1062, + "raw_signature": "mail_blacklist_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_blacklist_get", + "file": "mail.inc.php", + "line": 1026, + "raw_signature": "mail_blacklist_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_blacklist_update", + "file": "mail.inc.php", + "line": 1050, + "raw_signature": "mail_blacklist_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_catchall_add", + "file": "mail.inc.php", + "line": 543, + "raw_signature": "mail_catchall_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_catchall_delete", + "file": "mail.inc.php", + "line": 564, + "raw_signature": "mail_catchall_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_catchall_get", + "file": "mail.inc.php", + "line": 529, + "raw_signature": "mail_catchall_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_catchall_update", + "file": "mail.inc.php", + "line": 553, + "raw_signature": "mail_catchall_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_domain_add", + "file": "mail.inc.php", + "line": 57, + "raw_signature": "mail_domain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_domain_delete", + "file": "mail.inc.php", + "line": 86, + "raw_signature": "mail_domain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_domain_get", + "file": "mail.inc.php", + "line": 43, + "raw_signature": "mail_domain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_domain_get_by_domain", + "file": "mail.inc.php", + "line": 1132, + "raw_signature": "mail_domain_get_by_domain($session_id, $domain)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "domain", + "default": null + } + ], + "doc": { + "summary": "Fetch the mail_domain record for the provided domain.", + "params": [ + { + "type": "int", + "name": "session_id", + "desc": "" + }, + { + "type": "string", + "name": "the", + "desc": "fully qualified domain (or subdomain)" + } + ], + "return": { + "type": "array", + "desc": "array of arrays corresponding to the mail_domain table's records" + } + }, + "source_class": "mail" + }, + { + "method": "mail_domain_set_status", + "file": "mail.inc.php", + "line": 1147, + "raw_signature": "mail_domain_set_status($session_id, $primary_id, $status)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "status", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_domain_update", + "file": "mail.inc.php", + "line": 75, + "raw_signature": "mail_domain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_fetchmail_add", + "file": "mail.inc.php", + "line": 940, + "raw_signature": "mail_fetchmail_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_fetchmail_delete", + "file": "mail.inc.php", + "line": 962, + "raw_signature": "mail_fetchmail_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_fetchmail_get", + "file": "mail.inc.php", + "line": 926, + "raw_signature": "mail_fetchmail_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_fetchmail_update", + "file": "mail.inc.php", + "line": 950, + "raw_signature": "mail_fetchmail_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_filter_add", + "file": "mail.inc.php", + "line": 1090, + "raw_signature": "mail_filter_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_filter_delete", + "file": "mail.inc.php", + "line": 1112, + "raw_signature": "mail_filter_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_filter_get", + "file": "mail.inc.php", + "line": 1076, + "raw_signature": "mail_filter_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_filter_update", + "file": "mail.inc.php", + "line": 1100, + "raw_signature": "mail_filter_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_forward_add", + "file": "mail.inc.php", + "line": 493, + "raw_signature": "mail_forward_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_forward_delete", + "file": "mail.inc.php", + "line": 515, + "raw_signature": "mail_forward_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_forward_get", + "file": "mail.inc.php", + "line": 479, + "raw_signature": "mail_forward_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_forward_update", + "file": "mail.inc.php", + "line": 503, + "raw_signature": "mail_forward_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_mailinglist_add", + "file": "mail.inc.php", + "line": 160, + "raw_signature": "mail_mailinglist_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_mailinglist_delete", + "file": "mail.inc.php", + "line": 182, + "raw_signature": "mail_mailinglist_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_mailinglist_get", + "file": "mail.inc.php", + "line": 146, + "raw_signature": "mail_mailinglist_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_mailinglist_update", + "file": "mail.inc.php", + "line": 171, + "raw_signature": "mail_mailinglist_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_policy_add", + "file": "mail.inc.php", + "line": 890, + "raw_signature": "mail_policy_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_policy_delete", + "file": "mail.inc.php", + "line": 912, + "raw_signature": "mail_policy_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_policy_get", + "file": "mail.inc.php", + "line": 876, + "raw_signature": "mail_policy_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_policy_update", + "file": "mail.inc.php", + "line": 900, + "raw_signature": "mail_policy_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_domain_add", + "file": "mail.inc.php", + "line": 678, + "raw_signature": "mail_relay_domain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_domain_delete", + "file": "mail.inc.php", + "line": 688, + "raw_signature": "mail_relay_domain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_domain_get", + "file": "mail.inc.php", + "line": 699, + "raw_signature": "mail_relay_domain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_domain_update", + "file": "mail.inc.php", + "line": 713, + "raw_signature": "mail_relay_domain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_recipient_add", + "file": "mail.inc.php", + "line": 642, + "raw_signature": "mail_relay_recipient_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_recipient_delete", + "file": "mail.inc.php", + "line": 664, + "raw_signature": "mail_relay_recipient_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_recipient_get", + "file": "mail.inc.php", + "line": 627, + "raw_signature": "mail_relay_recipient_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_relay_recipient_update", + "file": "mail.inc.php", + "line": 652, + "raw_signature": "mail_relay_recipient_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_blacklist_add", + "file": "mail.inc.php", + "line": 790, + "raw_signature": "mail_spamfilter_blacklist_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_blacklist_delete", + "file": "mail.inc.php", + "line": 812, + "raw_signature": "mail_spamfilter_blacklist_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_blacklist_get", + "file": "mail.inc.php", + "line": 776, + "raw_signature": "mail_spamfilter_blacklist_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_blacklist_update", + "file": "mail.inc.php", + "line": 800, + "raw_signature": "mail_spamfilter_blacklist_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_user_add", + "file": "mail.inc.php", + "line": 840, + "raw_signature": "mail_spamfilter_user_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_user_delete", + "file": "mail.inc.php", + "line": 862, + "raw_signature": "mail_spamfilter_user_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_user_get", + "file": "mail.inc.php", + "line": 826, + "raw_signature": "mail_spamfilter_user_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_user_update", + "file": "mail.inc.php", + "line": 850, + "raw_signature": "mail_spamfilter_user_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_whitelist_add", + "file": "mail.inc.php", + "line": 740, + "raw_signature": "mail_spamfilter_whitelist_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_whitelist_delete", + "file": "mail.inc.php", + "line": 762, + "raw_signature": "mail_spamfilter_whitelist_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_whitelist_get", + "file": "mail.inc.php", + "line": 726, + "raw_signature": "mail_spamfilter_whitelist_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_spamfilter_whitelist_update", + "file": "mail.inc.php", + "line": 750, + "raw_signature": "mail_spamfilter_whitelist_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_transport_add", + "file": "mail.inc.php", + "line": 591, + "raw_signature": "mail_transport_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_transport_delete", + "file": "mail.inc.php", + "line": 613, + "raw_signature": "mail_transport_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_transport_get", + "file": "mail.inc.php", + "line": 577, + "raw_signature": "mail_transport_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_transport_update", + "file": "mail.inc.php", + "line": 601, + "raw_signature": "mail_transport_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_add", + "file": "mail.inc.php", + "line": 226, + "raw_signature": "mail_user_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_backup", + "file": "mail.inc.php", + "line": 366, + "raw_signature": "mail_user_backup($session_id, $primary_id, $action_type)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "action_type", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_backup_list", + "file": "mail.inc.php", + "line": 343, + "raw_signature": "mail_user_backup_list($session_id, $primary_id = null)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": "null" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_delete", + "file": "mail.inc.php", + "line": 279, + "raw_signature": "mail_user_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_filter_add", + "file": "mail.inc.php", + "line": 303, + "raw_signature": "mail_user_filter_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_filter_delete", + "file": "mail.inc.php", + "line": 328, + "raw_signature": "mail_user_filter_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_filter_get", + "file": "mail.inc.php", + "line": 291, + "raw_signature": "mail_user_filter_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_filter_update", + "file": "mail.inc.php", + "line": 315, + "raw_signature": "mail_user_filter_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_get", + "file": "mail.inc.php", + "line": 193, + "raw_signature": "mail_user_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_get_all_by_client", + "file": "mail.inc.php", + "line": 207, + "raw_signature": "mail_user_get_all_by_client($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_user_update", + "file": "mail.inc.php", + "line": 255, + "raw_signature": "mail_user_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_whitelist_add", + "file": "mail.inc.php", + "line": 990, + "raw_signature": "mail_whitelist_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_whitelist_delete", + "file": "mail.inc.php", + "line": 1012, + "raw_signature": "mail_whitelist_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_whitelist_get", + "file": "mail.inc.php", + "line": 976, + "raw_signature": "mail_whitelist_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mail_whitelist_update", + "file": "mail.inc.php", + "line": 1000, + "raw_signature": "mail_whitelist_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "mailquota_get_by_user", + "file": "mail.inc.php", + "line": 1171, + "raw_signature": "mailquota_get_by_user($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "mail" + }, + { + "method": "monitor_jobqueue_count", + "file": "monitor.inc.php", + "line": 36, + "raw_signature": "monitor_jobqueue_count($session_id, $server_id = 0)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_id", + "default": "0" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "monitor" + }, + { + "method": "openvz_get_free_ip", + "file": "openvz.inc.php", + "line": 151, + "raw_signature": "openvz_get_free_ip($session_id, $server_id = 0)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_id", + "default": "0" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ip_add", + "file": "openvz.inc.php", + "line": 175, + "raw_signature": "openvz_ip_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ip_delete", + "file": "openvz.inc.php", + "line": 196, + "raw_signature": "openvz_ip_delete($session_id, $ip_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "ip_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ip_get", + "file": "openvz.inc.php", + "line": 137, + "raw_signature": "openvz_ip_get($session_id, $ip_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "ip_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ip_update", + "file": "openvz.inc.php", + "line": 185, + "raw_signature": "openvz_ip_update($session_id, $client_id, $ip_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "ip_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ostemplate_add", + "file": "openvz.inc.php", + "line": 59, + "raw_signature": "openvz_ostemplate_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ostemplate_delete", + "file": "openvz.inc.php", + "line": 80, + "raw_signature": "openvz_ostemplate_delete($session_id, $ostemplate_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "ostemplate_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ostemplate_get", + "file": "openvz.inc.php", + "line": 45, + "raw_signature": "openvz_ostemplate_get($session_id, $ostemplate_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "ostemplate_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_ostemplate_update", + "file": "openvz.inc.php", + "line": 69, + "raw_signature": "openvz_ostemplate_update($session_id, $client_id, $ostemplate_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "ostemplate_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_template_add", + "file": "openvz.inc.php", + "line": 105, + "raw_signature": "openvz_template_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_template_delete", + "file": "openvz.inc.php", + "line": 126, + "raw_signature": "openvz_template_delete($session_id, $template_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "template_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_template_get", + "file": "openvz.inc.php", + "line": 91, + "raw_signature": "openvz_template_get($session_id, $template_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "template_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_template_update", + "file": "openvz.inc.php", + "line": 115, + "raw_signature": "openvz_template_update($session_id, $client_id, $template_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "template_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_add", + "file": "openvz.inc.php", + "line": 241, + "raw_signature": "openvz_vm_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_add_from_template", + "file": "openvz.inc.php", + "line": 251, + "raw_signature": "openvz_vm_add_from_template($session_id, $client_id, $ostemplate_id, $template_id, $override_params = array())", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "ostemplate_id", + "default": null + }, + { + "name": "template_id", + "default": null + }, + { + "name": "override_params", + "default": "array()" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_delete", + "file": "openvz.inc.php", + "line": 342, + "raw_signature": "openvz_vm_delete($session_id, $vm_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "vm_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_get", + "file": "openvz.inc.php", + "line": 207, + "raw_signature": "openvz_vm_get($session_id, $vm_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "vm_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_get_by_client", + "file": "openvz.inc.php", + "line": 221, + "raw_signature": "openvz_vm_get_by_client($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_restart", + "file": "openvz.inc.php", + "line": 437, + "raw_signature": "openvz_vm_restart($session_id, $vm_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "vm_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_start", + "file": "openvz.inc.php", + "line": 353, + "raw_signature": "openvz_vm_start($session_id, $vm_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "vm_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_stop", + "file": "openvz.inc.php", + "line": 395, + "raw_signature": "openvz_vm_stop($session_id, $vm_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "vm_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "openvz_vm_update", + "file": "openvz.inc.php", + "line": 331, + "raw_signature": "openvz_vm_update($session_id, $client_id, $vm_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "vm_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "openvz" + }, + { + "method": "server_config_set", + "file": "server.inc.php", + "line": 153, + "raw_signature": "server_config_set($session_id, $server_id, $section, $key, $value)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_id", + "default": null + }, + { + "name": "section", + "default": null + }, + { + "name": "key", + "default": null + }, + { + "name": "value", + "default": null + } + ], + "doc": { + "summary": "Set a value in the server configuration", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "server", + "desc": "id" + }, + { + "type": "string", + "name": "section", + "desc": "of the config field in the server table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc" + }, + { + "type": "string", + "name": "key", + "desc": "of the option that you want to set" + }, + { + "type": "string", + "name": "option", + "desc": "value that you want to set" + } + ], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_get", + "file": "server.inc.php", + "line": 116, + "raw_signature": "server_get($session_id, $server_id = null, $section ='')", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_id", + "default": "null" + }, + { + "name": "section", + "default": "''" + } + ], + "doc": { + "summary": "Gets the server configuration", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "server", + "desc": "id" + }, + { + "type": "string", + "name": "section", + "desc": "of the config field in the server table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc" + } + ], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_get_all", + "file": "server.inc.php", + "line": 179, + "raw_signature": "server_get_all($session_id)", + "params": [ + { + "name": "session_id", + "default": null + } + ], + "doc": { + "summary": "Gets a list of all servers", + "params": [ + { + "type": "int", + "name": "session_id", + "desc": "" + }, + { + "type": "int", + "name": "server_name", + "desc": "" + } + ], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_get_app_version", + "file": "server.inc.php", + "line": 238, + "raw_signature": "server_get_app_version($session_id, $server_id = 0)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_id", + "default": "0" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_get_functions", + "file": "server.inc.php", + "line": 223, + "raw_signature": "server_get_functions($session_id, $server_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_id", + "default": null + } + ], + "doc": { + "summary": "Gets the functions of a server by server_id", + "params": [ + { + "type": "int", + "name": "session_id", + "desc": "" + }, + { + "type": "int", + "name": "server_id", + "desc": "" + } + ], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_get_php_versions", + "file": "server.inc.php", + "line": 259, + "raw_signature": "server_get_php_versions($session_id, $server_id, $php, $get_full_data = false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_id", + "default": null + }, + { + "name": "php", + "default": null + }, + { + "name": "get_full_data", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_get_serverid_by_ip", + "file": "server.inc.php", + "line": 49, + "raw_signature": "server_get_serverid_by_ip($session_id, $ipaddress)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "ipaddress", + "default": null + } + ], + "doc": { + "summary": "Gets the server configuration", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "server", + "desc": "id" + }, + { + "type": "string", + "name": "section", + "desc": "of the config field in the server table. Could be 'web', 'dns', 'mail', 'dns', 'cron', etc" + } + ], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_get_serverid_by_name", + "file": "server.inc.php", + "line": 201, + "raw_signature": "server_get_serverid_by_name($session_id, $server_name)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "server_name", + "default": null + } + ], + "doc": { + "summary": "Gets the server_id by server_name", + "params": [ + { + "type": "int", + "name": "session_id", + "desc": "" + }, + { + "type": "int", + "name": "server_name", + "desc": "" + } + ], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_ip_add", + "file": "server.inc.php", + "line": 78, + "raw_signature": "server_ip_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_ip_delete", + "file": "server.inc.php", + "line": 99, + "raw_signature": "server_ip_delete($session_id, $ip_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "ip_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_ip_get", + "file": "server.inc.php", + "line": 64, + "raw_signature": "server_ip_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "server" + }, + { + "method": "server_ip_update", + "file": "server.inc.php", + "line": 88, + "raw_signature": "server_ip_update($session_id, $client_id, $ip_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "ip_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "server" + }, + { + "method": "client_get_sites_by_user", + "file": "sites.inc.php", + "line": 835, + "raw_signature": "client_get_sites_by_user($session_id, $sys_userid, $sys_groupid)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "sys_userid", + "default": null + }, + { + "name": "sys_groupid", + "default": null + } + ], + "doc": { + "summary": "Gets sites by $sys_userid & $sys_groupid", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "user", + "desc": "id" + }, + { + "type": "array", + "name": "list", + "desc": "of groups" + } + ], + "return": { + "type": "mixed", + "desc": "array with sites by user" + } + }, + "source_class": "sites" + }, + { + "method": "databasequota_get_by_user", + "file": "sites.inc.php", + "line": 1012, + "raw_signature": "databasequota_get_by_user($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "ftptrafficquota_data", + "file": "sites.inc.php", + "line": 997, + "raw_signature": "ftptrafficquota_data($session_id, $client_id, $lastdays = 0)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "lastdays", + "default": "0" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "quota_get_by_user", + "file": "sites.inc.php", + "line": 970, + "raw_signature": "quota_get_by_user($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_cron_add", + "file": "sites.inc.php", + "line": 59, + "raw_signature": "sites_cron_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_cron_delete", + "file": "sites.inc.php", + "line": 80, + "raw_signature": "sites_cron_delete($session_id, $cron_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "cron_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_cron_get", + "file": "sites.inc.php", + "line": 45, + "raw_signature": "sites_cron_get($session_id, $cron_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "cron_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_cron_update", + "file": "sites.inc.php", + "line": 69, + "raw_signature": "sites_cron_update($session_id, $client_id, $cron_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "cron_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_add", + "file": "sites.inc.php", + "line": 108, + "raw_signature": "sites_database_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_delete", + "file": "sites.inc.php", + "line": 185, + "raw_signature": "sites_database_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_get", + "file": "sites.inc.php", + "line": 93, + "raw_signature": "sites_database_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_get_all_by_user", + "file": "sites.inc.php", + "line": 898, + "raw_signature": "sites_database_get_all_by_user($session_id, $client_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + } + ], + "doc": { + "summary": "Get all databases by user", + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_update", + "file": "sites.inc.php", + "line": 151, + "raw_signature": "sites_database_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_user_add", + "file": "sites.inc.php", + "line": 217, + "raw_signature": "sites_database_user_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_user_delete", + "file": "sites.inc.php", + "line": 258, + "raw_signature": "sites_database_user_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_user_get", + "file": "sites.inc.php", + "line": 203, + "raw_signature": "sites_database_user_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_database_user_update", + "file": "sites.inc.php", + "line": 228, + "raw_signature": "sites_database_user_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_ftp_user_add", + "file": "sites.inc.php", + "line": 300, + "raw_signature": "sites_ftp_user_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_ftp_user_delete", + "file": "sites.inc.php", + "line": 321, + "raw_signature": "sites_ftp_user_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_ftp_user_get", + "file": "sites.inc.php", + "line": 286, + "raw_signature": "sites_ftp_user_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_ftp_user_server_get", + "file": "sites.inc.php", + "line": 332, + "raw_signature": "sites_ftp_user_server_get($session_id, $ftp_user)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "ftp_user", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_ftp_user_update", + "file": "sites.inc.php", + "line": 310, + "raw_signature": "sites_ftp_user_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_shell_user_add", + "file": "sites.inc.php", + "line": 368, + "raw_signature": "sites_shell_user_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_shell_user_delete", + "file": "sites.inc.php", + "line": 389, + "raw_signature": "sites_shell_user_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_shell_user_get", + "file": "sites.inc.php", + "line": 354, + "raw_signature": "sites_shell_user_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_shell_user_update", + "file": "sites.inc.php", + "line": 378, + "raw_signature": "sites_shell_user_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_aliasdomain_add", + "file": "sites.inc.php", + "line": 642, + "raw_signature": "sites_web_aliasdomain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_aliasdomain_delete", + "file": "sites.inc.php", + "line": 663, + "raw_signature": "sites_web_aliasdomain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_aliasdomain_get", + "file": "sites.inc.php", + "line": 628, + "raw_signature": "sites_web_aliasdomain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_aliasdomain_update", + "file": "sites.inc.php", + "line": 652, + "raw_signature": "sites_web_aliasdomain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_domain_add", + "file": "sites.inc.php", + "line": 416, + "raw_signature": "sites_web_domain_add($session_id, $client_id, $params, $readonly = false)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + }, + { + "name": "readonly", + "default": "false" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_domain_backup", + "file": "sites.inc.php", + "line": 926, + "raw_signature": "sites_web_domain_backup($session_id, $primary_id, $action_type)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "action_type", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_domain_backup_list", + "file": "sites.inc.php", + "line": 912, + "raw_signature": "sites_web_domain_backup_list($session_id, $site_id = null)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "site_id", + "default": "null" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_domain_delete", + "file": "sites.inc.php", + "line": 471, + "raw_signature": "sites_web_domain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_domain_get", + "file": "sites.inc.php", + "line": 402, + "raw_signature": "sites_web_domain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_domain_set_status", + "file": "sites.inc.php", + "line": 870, + "raw_signature": "sites_web_domain_set_status($session_id, $primary_id, $status)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "status", + "default": null + } + ], + "doc": { + "summary": "Change domains status", + "params": [ + { + "type": "int", + "name": "session", + "desc": "id" + }, + { + "type": "int", + "name": "site", + "desc": "id" + }, + { + "type": "string", + "name": "active", + "desc": "or inactive string" + } + ], + "return": { + "type": "mixed", + "desc": "false if error" + } + }, + "source_class": "sites" + }, + { + "method": "sites_web_domain_update", + "file": "sites.inc.php", + "line": 451, + "raw_signature": "sites_web_domain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_add", + "file": "sites.inc.php", + "line": 738, + "raw_signature": "sites_web_folder_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_delete", + "file": "sites.inc.php", + "line": 759, + "raw_signature": "sites_web_folder_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_get", + "file": "sites.inc.php", + "line": 724, + "raw_signature": "sites_web_folder_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_update", + "file": "sites.inc.php", + "line": 748, + "raw_signature": "sites_web_folder_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_user_add", + "file": "sites.inc.php", + "line": 796, + "raw_signature": "sites_web_folder_user_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_user_delete", + "file": "sites.inc.php", + "line": 817, + "raw_signature": "sites_web_folder_user_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_user_get", + "file": "sites.inc.php", + "line": 782, + "raw_signature": "sites_web_folder_user_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_folder_user_update", + "file": "sites.inc.php", + "line": 806, + "raw_signature": "sites_web_folder_user_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_subdomain_add", + "file": "sites.inc.php", + "line": 690, + "raw_signature": "sites_web_subdomain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_subdomain_delete", + "file": "sites.inc.php", + "line": 711, + "raw_signature": "sites_web_subdomain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_subdomain_get", + "file": "sites.inc.php", + "line": 676, + "raw_signature": "sites_web_subdomain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_subdomain_update", + "file": "sites.inc.php", + "line": 700, + "raw_signature": "sites_web_subdomain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_aliasdomain_add", + "file": "sites.inc.php", + "line": 498, + "raw_signature": "sites_web_vhost_aliasdomain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_aliasdomain_delete", + "file": "sites.inc.php", + "line": 543, + "raw_signature": "sites_web_vhost_aliasdomain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_aliasdomain_get", + "file": "sites.inc.php", + "line": 484, + "raw_signature": "sites_web_vhost_aliasdomain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_aliasdomain_update", + "file": "sites.inc.php", + "line": 523, + "raw_signature": "sites_web_vhost_aliasdomain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_subdomain_add", + "file": "sites.inc.php", + "line": 570, + "raw_signature": "sites_web_vhost_subdomain_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_subdomain_delete", + "file": "sites.inc.php", + "line": 615, + "raw_signature": "sites_web_vhost_subdomain_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_subdomain_get", + "file": "sites.inc.php", + "line": 556, + "raw_signature": "sites_web_vhost_subdomain_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_web_vhost_subdomain_update", + "file": "sites.inc.php", + "line": 595, + "raw_signature": "sites_web_vhost_subdomain_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_webdav_user_add", + "file": "sites.inc.php", + "line": 1043, + "raw_signature": "sites_webdav_user_add($session_id, $client_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_webdav_user_delete", + "file": "sites.inc.php", + "line": 1064, + "raw_signature": "sites_webdav_user_delete($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_webdav_user_get", + "file": "sites.inc.php", + "line": 1029, + "raw_signature": "sites_webdav_user_get($session_id, $primary_id)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "primary_id", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "sites_webdav_user_update", + "file": "sites.inc.php", + "line": 1053, + "raw_signature": "sites_webdav_user_update($session_id, $client_id, $primary_id, $params)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "primary_id", + "default": null + }, + { + "name": "params", + "default": null + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + }, + { + "method": "trafficquota_get_by_user", + "file": "sites.inc.php", + "line": 982, + "raw_signature": "trafficquota_get_by_user($session_id, $client_id, $lastdays = 0)", + "params": [ + { + "name": "session_id", + "default": null + }, + { + "name": "client_id", + "default": null + }, + { + "name": "lastdays", + "default": "0" + } + ], + "doc": { + "summary": null, + "params": [], + "return": null + }, + "source_class": "sites" + } +]