mywebapi-sdk 0.3.0__py3-none-any.whl

cplugin_webapi_sdk/_generated/api/mt4_v_2_config/get_api_v_2_mt4_trade_platform_cfg_request_access.py

@@ -0,0 +1,280 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.mt4_access_list_api_response import MT4AccessListApiResponse
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    *,
+    limit: int | Unset = UNSET,
+    cursor: str | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(x_request_timeout, Unset):
+        headers["X-Request-Timeout"] = str(x_request_timeout)
+
+
+
+
+    
+
+    params: dict[str, Any] = {}
+
+    params["limit"] = limit
+
+    params["cursor"] = cursor
+
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v2/MT4/{trade_platform}/CfgRequestAccess".format(trade_platform=quote(str(trade_platform), safe=""),),
+        "params": params,
+    }
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MT4AccessListApiResponse | None:
+    if response.status_code == 200:
+        response_200 = MT4AccessListApiResponse.from_dict(response.json())
+
+
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[MT4AccessListApiResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = UNSET,
+    cursor: str | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4AccessListApiResponse]:
+    r""" List IP firewall rules
+
+     All firewall (IP access) rules configured on the MT4 server, paginated.
+
+    Manager-live read (round-trip). Each entry describes an IP range
+    (IpFrom..IpTo, widened uint→long for JSON safety) with an Action
+    flag and a free-form Comment. Ordering: by (IpFrom, IpTo) ascending.
+    Cursor is an opaque base64 string holding the composite key
+    \"{IpFrom:D10}|{IpTo:D10}\" — D10 width matches uint range (max
+    4_294_967_295 = 10 digits) so lexicographic compare matches
+    numeric compare, and the '|' delimiter cannot appear in IP values.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        limit (int | Unset):
+        cursor (str | Unset):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[MT4AccessListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+limit=limit,
+cursor=cursor,
+x_request_timeout=x_request_timeout,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = UNSET,
+    cursor: str | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4AccessListApiResponse | None:
+    r""" List IP firewall rules
+
+     All firewall (IP access) rules configured on the MT4 server, paginated.
+
+    Manager-live read (round-trip). Each entry describes an IP range
+    (IpFrom..IpTo, widened uint→long for JSON safety) with an Action
+    flag and a free-form Comment. Ordering: by (IpFrom, IpTo) ascending.
+    Cursor is an opaque base64 string holding the composite key
+    \"{IpFrom:D10}|{IpTo:D10}\" — D10 width matches uint range (max
+    4_294_967_295 = 10 digits) so lexicographic compare matches
+    numeric compare, and the '|' delimiter cannot appear in IP values.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        limit (int | Unset):
+        cursor (str | Unset):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        MT4AccessListApiResponse
+     """
+
+
+    return sync_detailed(
+        trade_platform=trade_platform,
+client=client,
+limit=limit,
+cursor=cursor,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = UNSET,
+    cursor: str | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4AccessListApiResponse]:
+    r""" List IP firewall rules
+
+     All firewall (IP access) rules configured on the MT4 server, paginated.
+
+    Manager-live read (round-trip). Each entry describes an IP range
+    (IpFrom..IpTo, widened uint→long for JSON safety) with an Action
+    flag and a free-form Comment. Ordering: by (IpFrom, IpTo) ascending.
+    Cursor is an opaque base64 string holding the composite key
+    \"{IpFrom:D10}|{IpTo:D10}\" — D10 width matches uint range (max
+    4_294_967_295 = 10 digits) so lexicographic compare matches
+    numeric compare, and the '|' delimiter cannot appear in IP values.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        limit (int | Unset):
+        cursor (str | Unset):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[MT4AccessListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+limit=limit,
+cursor=cursor,
+x_request_timeout=x_request_timeout,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = UNSET,
+    cursor: str | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4AccessListApiResponse | None:
+    r""" List IP firewall rules
+
+     All firewall (IP access) rules configured on the MT4 server, paginated.
+
+    Manager-live read (round-trip). Each entry describes an IP range
+    (IpFrom..IpTo, widened uint→long for JSON safety) with an Action
+    flag and a free-form Comment. Ordering: by (IpFrom, IpTo) ascending.
+    Cursor is an opaque base64 string holding the composite key
+    \"{IpFrom:D10}|{IpTo:D10}\" — D10 width matches uint range (max
+    4_294_967_295 = 10 digits) so lexicographic compare matches
+    numeric compare, and the '|' delimiter cannot appear in IP values.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        limit (int | Unset):
+        cursor (str | Unset):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        MT4AccessListApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+client=client,
+limit=limit,
+cursor=cursor,
+x_request_timeout=x_request_timeout,
+
+    )).parsed

cplugin_webapi_sdk/_generated/api/mt4_v_2_config/get_api_v_2_mt4_trade_platform_cfg_request_backup.py

@@ -0,0 +1,241 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.mt4_backup_api_response import MT4BackupApiResponse
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    *,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(x_request_timeout, Unset):
+        headers["X-Request-Timeout"] = str(x_request_timeout)
+
+
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v2/MT4/{trade_platform}/CfgRequestBackup".format(trade_platform=quote(str(trade_platform), safe=""),),
+    }
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MT4BackupApiResponse | None:
+    if response.status_code == 200:
+        response_200 = MT4BackupApiResponse.from_dict(response.json())
+
+
+
+        return response_200
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[MT4BackupApiResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4BackupApiResponse]:
+    """ Get backup config
+
+     MT4 server backup configuration (full + archive + export schedules, watchdog HA pair settings).
+
+    Manager-live read (round-trip). Returns the wrapper's ConBackup as
+    MT4Backup DTO — full/archive/export schedule enums and paths, last
+    completion timestamps, and HA-watchdog fields. The wrapper's
+    `WatchPassword` (slave-server credential) is intentionally
+    dropped from the v2 contract for security and is NOT present in
+    the response payload.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[MT4BackupApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+x_request_timeout=x_request_timeout,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4BackupApiResponse | None:
+    """ Get backup config
+
+     MT4 server backup configuration (full + archive + export schedules, watchdog HA pair settings).
+
+    Manager-live read (round-trip). Returns the wrapper's ConBackup as
+    MT4Backup DTO — full/archive/export schedule enums and paths, last
+    completion timestamps, and HA-watchdog fields. The wrapper's
+    `WatchPassword` (slave-server credential) is intentionally
+    dropped from the v2 contract for security and is NOT present in
+    the response payload.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        MT4BackupApiResponse
+     """
+
+
+    return sync_detailed(
+        trade_platform=trade_platform,
+client=client,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4BackupApiResponse]:
+    """ Get backup config
+
+     MT4 server backup configuration (full + archive + export schedules, watchdog HA pair settings).
+
+    Manager-live read (round-trip). Returns the wrapper's ConBackup as
+    MT4Backup DTO — full/archive/export schedule enums and paths, last
+    completion timestamps, and HA-watchdog fields. The wrapper's
+    `WatchPassword` (slave-server credential) is intentionally
+    dropped from the v2 contract for security and is NOT present in
+    the response payload.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[MT4BackupApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+x_request_timeout=x_request_timeout,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4BackupApiResponse | None:
+    """ Get backup config
+
+     MT4 server backup configuration (full + archive + export schedules, watchdog HA pair settings).
+
+    Manager-live read (round-trip). Returns the wrapper's ConBackup as
+    MT4Backup DTO — full/archive/export schedule enums and paths, last
+    completion timestamps, and HA-watchdog fields. The wrapper's
+    `WatchPassword` (slave-server credential) is intentionally
+    dropped from the v2 contract for security and is NOT present in
+    the response payload.
+
+    **Timeout:** 10 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: Nothing was changed; the request is safe to repeat.
+
+    Args:
+        trade_platform (UUID):
+        x_request_timeout (float | Unset):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        MT4BackupApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+client=client,
+x_request_timeout=x_request_timeout,
+
+    )).parsed