mywebapi-sdk 0.3.0__py3-none-any.whl

cplugin_webapi_sdk/_generated/api/mt4_v_2_backup/get_api_v_2_mt4_trade_platform_backup_info_users_mode.py

@@ -0,0 +1,262 @@
+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_info_list_api_response import MT4BackupInfoListApiResponse
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    mode: int,
+    *,
+    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}/BackupInfoUsers/{mode}".format(trade_platform=quote(str(trade_platform), safe=""),mode=quote(str(mode), safe=""),),
+    }
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MT4BackupInfoListApiResponse | None:
+    if response.status_code == 200:
+        response_200 = MT4BackupInfoListApiResponse.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[MT4BackupInfoListApiResponse]:
+    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,
+    mode: int,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4BackupInfoListApiResponse]:
+    """ List user backup files
+
+     List backup user files available on the MT4 server for a given mode.
+
+    Manager (live) call to the wrapper's
+    `BackupInfoUsers(int mode)`. Returns the catalog of backup
+    files (filename, size, mtime) — does NOT touch the files themselves.
+    Read-only operation: safe to call repeatedly.
+    <br>`mode` is the server-defined backup mode selector (typical
+    values: `0` = daily, `1` = weekly — confirm against your
+    server's `ConBackup` configuration).
+
+
+    **Timeout:** 30 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):
+        mode (int):
+        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[MT4BackupInfoListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+mode=mode,
+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,
+    mode: int,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4BackupInfoListApiResponse | None:
+    """ List user backup files
+
+     List backup user files available on the MT4 server for a given mode.
+
+    Manager (live) call to the wrapper's
+    `BackupInfoUsers(int mode)`. Returns the catalog of backup
+    files (filename, size, mtime) — does NOT touch the files themselves.
+    Read-only operation: safe to call repeatedly.
+    <br>`mode` is the server-defined backup mode selector (typical
+    values: `0` = daily, `1` = weekly — confirm against your
+    server's `ConBackup` configuration).
+
+
+    **Timeout:** 30 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):
+        mode (int):
+        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:
+        MT4BackupInfoListApiResponse
+     """
+
+
+    return sync_detailed(
+        trade_platform=trade_platform,
+mode=mode,
+client=client,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    mode: int,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4BackupInfoListApiResponse]:
+    """ List user backup files
+
+     List backup user files available on the MT4 server for a given mode.
+
+    Manager (live) call to the wrapper's
+    `BackupInfoUsers(int mode)`. Returns the catalog of backup
+    files (filename, size, mtime) — does NOT touch the files themselves.
+    Read-only operation: safe to call repeatedly.
+    <br>`mode` is the server-defined backup mode selector (typical
+    values: `0` = daily, `1` = weekly — confirm against your
+    server's `ConBackup` configuration).
+
+
+    **Timeout:** 30 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):
+        mode (int):
+        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[MT4BackupInfoListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+mode=mode,
+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,
+    mode: int,
+    *,
+    client: AuthenticatedClient | Client,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4BackupInfoListApiResponse | None:
+    """ List user backup files
+
+     List backup user files available on the MT4 server for a given mode.
+
+    Manager (live) call to the wrapper's
+    `BackupInfoUsers(int mode)`. Returns the catalog of backup
+    files (filename, size, mtime) — does NOT touch the files themselves.
+    Read-only operation: safe to call repeatedly.
+    <br>`mode` is the server-defined backup mode selector (typical
+    values: `0` = daily, `1` = weekly — confirm against your
+    server's `ConBackup` configuration).
+
+
+    **Timeout:** 30 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):
+        mode (int):
+        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:
+        MT4BackupInfoListApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+mode=mode,
+client=client,
+x_request_timeout=x_request_timeout,
+
+    )).parsed

cplugin_webapi_sdk/_generated/api/mt4_v_2_backup/get_api_v_2_mt4_trade_platform_backup_request_orders_file.py

@@ -0,0 +1,285 @@
+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_trade_list_api_response import MT4TradeListApiResponse
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    file: str,
+    *,
+    request: str | Unset = UNSET,
+    limit: int | Unset = 10000,
+    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["request"] = request
+
+    params["limit"] = limit
+
+
+    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}/BackupRequestOrders/{file}".format(trade_platform=quote(str(trade_platform), safe=""),file=quote(str(file), safe=""),),
+        "params": params,
+    }
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MT4TradeListApiResponse | None:
+    if response.status_code == 200:
+        response_200 = MT4TradeListApiResponse.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[MT4TradeListApiResponse]:
+    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,
+    file: str,
+    *,
+    client: AuthenticatedClient | Client,
+    request: str | Unset = UNSET,
+    limit: int | Unset = 10000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4TradeListApiResponse]:
+    """ Read orders from backup
+
+     Read trade records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestOrders(string file, string request)`. Order-side
+    counterpart of `BackupRequestUsers`. Same caveats:
+    read-only, full file loaded server-side regardless of `limit`,
+    destructive restore is a separate (Wave 4b) operation.
+
+    **Timeout:** 30 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):
+        file (str):
+        request (str | Unset):
+        limit (int | Unset):  Default: 10000.
+        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[MT4TradeListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+file=file,
+request=request,
+limit=limit,
+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,
+    file: str,
+    *,
+    client: AuthenticatedClient | Client,
+    request: str | Unset = UNSET,
+    limit: int | Unset = 10000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4TradeListApiResponse | None:
+    """ Read orders from backup
+
+     Read trade records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestOrders(string file, string request)`. Order-side
+    counterpart of `BackupRequestUsers`. Same caveats:
+    read-only, full file loaded server-side regardless of `limit`,
+    destructive restore is a separate (Wave 4b) operation.
+
+    **Timeout:** 30 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):
+        file (str):
+        request (str | Unset):
+        limit (int | Unset):  Default: 10000.
+        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:
+        MT4TradeListApiResponse
+     """
+
+
+    return sync_detailed(
+        trade_platform=trade_platform,
+file=file,
+client=client,
+request=request,
+limit=limit,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    file: str,
+    *,
+    client: AuthenticatedClient | Client,
+    request: str | Unset = UNSET,
+    limit: int | Unset = 10000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4TradeListApiResponse]:
+    """ Read orders from backup
+
+     Read trade records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestOrders(string file, string request)`. Order-side
+    counterpart of `BackupRequestUsers`. Same caveats:
+    read-only, full file loaded server-side regardless of `limit`,
+    destructive restore is a separate (Wave 4b) operation.
+
+    **Timeout:** 30 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):
+        file (str):
+        request (str | Unset):
+        limit (int | Unset):  Default: 10000.
+        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[MT4TradeListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+file=file,
+request=request,
+limit=limit,
+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,
+    file: str,
+    *,
+    client: AuthenticatedClient | Client,
+    request: str | Unset = UNSET,
+    limit: int | Unset = 10000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4TradeListApiResponse | None:
+    """ Read orders from backup
+
+     Read trade records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestOrders(string file, string request)`. Order-side
+    counterpart of `BackupRequestUsers`. Same caveats:
+    read-only, full file loaded server-side regardless of `limit`,
+    destructive restore is a separate (Wave 4b) operation.
+
+    **Timeout:** 30 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):
+        file (str):
+        request (str | Unset):
+        limit (int | Unset):  Default: 10000.
+        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:
+        MT4TradeListApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+file=file,
+client=client,
+request=request,
+limit=limit,
+x_request_timeout=x_request_timeout,
+
+    )).parsed