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_request_users_file.py

@@ -0,0 +1,325 @@
+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_user_list_api_response import MT4UserListApiResponse
+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}/BackupRequestUsers/{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) -> MT4UserListApiResponse | None:
+    if response.status_code == 200:
+        response_200 = MT4UserListApiResponse.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[MT4UserListApiResponse]:
+    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[MT4UserListApiResponse]:
+    """ Read users from backup
+
+     Read user records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestUsers(string file, string request)`. The wrapper
+    extracts records from the named backup file but does NOT write
+    them back to the live DB — that requires a separate (destructive)
+    `BackupRestoreUsers` call which is part of Wave 4b.
+    <br>
+    Use `BackupInfoUsers` first to discover valid
+    file names. The optional `request` query
+    is a server-defined filter string; empty string returns all users.
+    <br><b>Heavy operation:</b> backup files can contain millions of
+    records — the wrapper returns the full set in one shot. The
+    optional `limit` query truncates the response server-side
+    (default 10000, max 100000). The wrapper still loads the full
+    file regardless of limit — limit only caps the JSON response size.
+
+
+    **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[MT4UserListApiResponse]
+     """
+
+
+    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,
+
+) -> MT4UserListApiResponse | None:
+    """ Read users from backup
+
+     Read user records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestUsers(string file, string request)`. The wrapper
+    extracts records from the named backup file but does NOT write
+    them back to the live DB — that requires a separate (destructive)
+    `BackupRestoreUsers` call which is part of Wave 4b.
+    <br>
+    Use `BackupInfoUsers` first to discover valid
+    file names. The optional `request` query
+    is a server-defined filter string; empty string returns all users.
+    <br><b>Heavy operation:</b> backup files can contain millions of
+    records — the wrapper returns the full set in one shot. The
+    optional `limit` query truncates the response server-side
+    (default 10000, max 100000). The wrapper still loads the full
+    file regardless of limit — limit only caps the JSON response size.
+
+
+    **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:
+        MT4UserListApiResponse
+     """
+
+
+    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[MT4UserListApiResponse]:
+    """ Read users from backup
+
+     Read user records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestUsers(string file, string request)`. The wrapper
+    extracts records from the named backup file but does NOT write
+    them back to the live DB — that requires a separate (destructive)
+    `BackupRestoreUsers` call which is part of Wave 4b.
+    <br>
+    Use `BackupInfoUsers` first to discover valid
+    file names. The optional `request` query
+    is a server-defined filter string; empty string returns all users.
+    <br><b>Heavy operation:</b> backup files can contain millions of
+    records — the wrapper returns the full set in one shot. The
+    optional `limit` query truncates the response server-side
+    (default 10000, max 100000). The wrapper still loads the full
+    file regardless of limit — limit only caps the JSON response size.
+
+
+    **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[MT4UserListApiResponse]
+     """
+
+
+    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,
+
+) -> MT4UserListApiResponse | None:
+    """ Read users from backup
+
+     Read user records out of a backup file (does NOT restore — read-only).
+
+    Manager (live) call to the wrapper's
+    `BackupRequestUsers(string file, string request)`. The wrapper
+    extracts records from the named backup file but does NOT write
+    them back to the live DB — that requires a separate (destructive)
+    `BackupRestoreUsers` call which is part of Wave 4b.
+    <br>
+    Use `BackupInfoUsers` first to discover valid
+    file names. The optional `request` query
+    is a server-defined filter string; empty string returns all users.
+    <br><b>Heavy operation:</b> backup files can contain millions of
+    records — the wrapper returns the full set in one shot. The
+    optional `limit` query truncates the response server-side
+    (default 10000, max 100000). The wrapper still loads the full
+    file regardless of limit — limit only caps the JSON response size.
+
+
+    **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:
+        MT4UserListApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+file=file,
+client=client,
+request=request,
+limit=limit,
+x_request_timeout=x_request_timeout,
+
+    )).parsed

cplugin_webapi_sdk/_generated/api/mt4_v_2_backup_destructive/__init__.py

@@ -0,0 +1 @@
+""" Contains endpoint functions for accessing the API """

cplugin_webapi_sdk/_generated/api/mt4_v_2_backup_destructive/post_api_v_2_mt4_trade_platform_backup_restore_orders.py

@@ -0,0 +1,332 @@
+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_restore_input import MT4TradeRestoreInput
+from ...models.mt4_trade_restore_result_list_api_response import MT4TradeRestoreResultListApiResponse
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    *,
+    body:    list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  | Unset = UNSET,
+    confirm: bool | Unset = False,
+    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["confirm"] = confirm
+
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v2/MT4/{trade_platform}/BackupRestoreOrders".format(trade_platform=quote(str(trade_platform), safe=""),),
+        "params": params,
+    }
+
+    if isinstance(body, list[MT4TradeRestoreInput]):
+        
+        if not isinstance(body, Unset):
+            _kwargs["json"] = []
+            for body_item_data in body:
+                body_item = body_item_data.to_dict()
+                _kwargs["json"].append(body_item)
+
+
+
+        headers["Content-Type"] = "application/json-patch+json"
+    if isinstance(body, list[MT4TradeRestoreInput]):
+        
+        if not isinstance(body, Unset):
+            _kwargs["json"] = []
+            for body_item_data in body:
+                body_item = body_item_data.to_dict()
+                _kwargs["json"].append(body_item)
+
+
+
+        headers["Content-Type"] = "application/json"
+    if isinstance(body, list[MT4TradeRestoreInput]):
+        
+        if not isinstance(body, Unset):
+            _kwargs["json"] = []
+            for body_item_data in body:
+                body_item = body_item_data.to_dict()
+                _kwargs["json"].append(body_item)
+
+
+
+        headers["Content-Type"] = "application/*+json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MT4TradeRestoreResultListApiResponse | None:
+    if response.status_code == 200:
+        response_200 = MT4TradeRestoreResultListApiResponse.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[MT4TradeRestoreResultListApiResponse]:
+    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,
+    body:    list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  | Unset = UNSET,
+    confirm: bool | Unset = False,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4TradeRestoreResultListApiResponse]:
+    """ Restore orders from backup
+
+     Restore order records into the live MT4 database. Destructive — requires `?confirm=true`.
+
+    Manager (live) call to the wrapper's
+    `BackupRestoreOrders(TradeRecord[] trades)`. Returns
+    `MT4TradeRestoreResult[]` — one entry per input trade, with
+    `Order` (ticket) and `Res` (0 = error, 1 = restored).
+    Position in the response array matches position in the request.
+    <br>
+    Idempotency-Key header is <b>strongly recommended</b>. Batch cap:
+    10000 records per call.
+
+
+    **Timeout:** 60 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: The operation may still be completed by the server
+    (`X-Request-Outcome: unknown`): check its result before repeating it.
+
+    Args:
+        trade_platform (UUID):
+        confirm (bool | Unset):  Default: False.
+        x_request_timeout (float | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | 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[MT4TradeRestoreResultListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+body=body,
+confirm=confirm,
+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,
+    body:    list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  | Unset = UNSET,
+    confirm: bool | Unset = False,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4TradeRestoreResultListApiResponse | None:
+    """ Restore orders from backup
+
+     Restore order records into the live MT4 database. Destructive — requires `?confirm=true`.
+
+    Manager (live) call to the wrapper's
+    `BackupRestoreOrders(TradeRecord[] trades)`. Returns
+    `MT4TradeRestoreResult[]` — one entry per input trade, with
+    `Order` (ticket) and `Res` (0 = error, 1 = restored).
+    Position in the response array matches position in the request.
+    <br>
+    Idempotency-Key header is <b>strongly recommended</b>. Batch cap:
+    10000 records per call.
+
+
+    **Timeout:** 60 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: The operation may still be completed by the server
+    (`X-Request-Outcome: unknown`): check its result before repeating it.
+
+    Args:
+        trade_platform (UUID):
+        confirm (bool | Unset):  Default: False.
+        x_request_timeout (float | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | 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:
+        MT4TradeRestoreResultListApiResponse
+     """
+
+
+    return sync_detailed(
+        trade_platform=trade_platform,
+client=client,
+body=body,
+confirm=confirm,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    body:    list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  | Unset = UNSET,
+    confirm: bool | Unset = False,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4TradeRestoreResultListApiResponse]:
+    """ Restore orders from backup
+
+     Restore order records into the live MT4 database. Destructive — requires `?confirm=true`.
+
+    Manager (live) call to the wrapper's
+    `BackupRestoreOrders(TradeRecord[] trades)`. Returns
+    `MT4TradeRestoreResult[]` — one entry per input trade, with
+    `Order` (ticket) and `Res` (0 = error, 1 = restored).
+    Position in the response array matches position in the request.
+    <br>
+    Idempotency-Key header is <b>strongly recommended</b>. Batch cap:
+    10000 records per call.
+
+
+    **Timeout:** 60 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: The operation may still be completed by the server
+    (`X-Request-Outcome: unknown`): check its result before repeating it.
+
+    Args:
+        trade_platform (UUID):
+        confirm (bool | Unset):  Default: False.
+        x_request_timeout (float | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | 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[MT4TradeRestoreResultListApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+body=body,
+confirm=confirm,
+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,
+    body:    list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  |     list[MT4TradeRestoreInput]  | Unset = UNSET,
+    confirm: bool | Unset = False,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4TradeRestoreResultListApiResponse | None:
+    """ Restore orders from backup
+
+     Restore order records into the live MT4 database. Destructive — requires `?confirm=true`.
+
+    Manager (live) call to the wrapper's
+    `BackupRestoreOrders(TradeRecord[] trades)`. Returns
+    `MT4TradeRestoreResult[]` — one entry per input trade, with
+    `Order` (ticket) and `Res` (0 = error, 1 = restored).
+    Position in the response array matches position in the request.
+    <br>
+    Idempotency-Key header is <b>strongly recommended</b>. Batch cap:
+    10000 records per call.
+
+
+    **Timeout:** 60 s by default, adjustable per request with the `X-Request-Timeout` header. When the
+    trade server does not answer in time: The operation may still be completed by the server
+    (`X-Request-Outcome: unknown`): check its result before repeating it.
+
+    Args:
+        trade_platform (UUID):
+        confirm (bool | Unset):  Default: False.
+        x_request_timeout (float | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | Unset):
+        body (list[MT4TradeRestoreInput] | 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:
+        MT4TradeRestoreResultListApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+client=client,
+body=body,
+confirm=confirm,
+x_request_timeout=x_request_timeout,
+
+    )).parsed