mywebapi-sdk 0.3.0__py3-none-any.whl

cplugin_webapi_sdk/_generated/api/mt4_v_2_sidecar_batch_reads/get_api_v_2_mt4_trade_platform_users_snapshot.py

@@ -0,0 +1,257 @@
+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,
+    *,
+    limit: int | Unset = 100000,
+    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 = {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}/UsersSnapshot".format(trade_platform=quote(str(trade_platform), 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,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4UserListApiResponse]:
+    """ Snapshot all users
+
+     Atomic snapshot of all registered users on the MT4 server.
+
+    Manager (live) call to the wrapper's `UsersSnapshot()`.
+    Iterates `UnpackObject<UserRecord>(i)` over the native
+    array — on mtmanapi64.dll the per-struct cost combined with
+    ASLR alignment triggers access violations after some iterations,
+    so this endpoint is sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+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,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4UserListApiResponse | None:
+    """ Snapshot all users
+
+     Atomic snapshot of all registered users on the MT4 server.
+
+    Manager (live) call to the wrapper's `UsersSnapshot()`.
+    Iterates `UnpackObject<UserRecord>(i)` over the native
+    array — on mtmanapi64.dll the per-struct cost combined with
+    ASLR alignment triggers access violations after some iterations,
+    so this endpoint is sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+client=client,
+limit=limit,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4UserListApiResponse]:
+    """ Snapshot all users
+
+     Atomic snapshot of all registered users on the MT4 server.
+
+    Manager (live) call to the wrapper's `UsersSnapshot()`.
+    Iterates `UnpackObject<UserRecord>(i)` over the native
+    array — on mtmanapi64.dll the per-struct cost combined with
+    ASLR alignment triggers access violations after some iterations,
+    so this endpoint is sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+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,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4UserListApiResponse | None:
+    """ Snapshot all users
+
+     Atomic snapshot of all registered users on the MT4 server.
+
+    Manager (live) call to the wrapper's `UsersSnapshot()`.
+    Iterates `UnpackObject<UserRecord>(i)` over the native
+    array — on mtmanapi64.dll the per-struct cost combined with
+    ASLR alignment triggers access violations after some iterations,
+    so this endpoint is sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+client=client,
+limit=limit,
+x_request_timeout=x_request_timeout,
+
+    )).parsed

cplugin_webapi_sdk/_generated/api/mt4_v_2_sidecar_batch_reads/get_api_v_2_mt4_trade_platform_users_sync_read.py

@@ -0,0 +1,253 @@
+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,
+    *,
+    limit: int | Unset = 100000,
+    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 = {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}/UsersSyncRead".format(trade_platform=quote(str(trade_platform), 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,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4UserListApiResponse]:
+    """ Read user-records sync
+
+     Read user records buffered by a prior `UsersSyncStart` call.
+
+    Manager (live) call to the wrapper's `UsersSyncRead()`.
+    Must be preceded by `POST UsersSyncStart` on the main x64
+    API to seed the server-side snapshot. Same UnpackObject hazard
+    as `UsersSnapshot` — sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+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,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4UserListApiResponse | None:
+    """ Read user-records sync
+
+     Read user records buffered by a prior `UsersSyncStart` call.
+
+    Manager (live) call to the wrapper's `UsersSyncRead()`.
+    Must be preceded by `POST UsersSyncStart` on the main x64
+    API to seed the server-side snapshot. Same UnpackObject hazard
+    as `UsersSnapshot` — sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+client=client,
+limit=limit,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[MT4UserListApiResponse]:
+    """ Read user-records sync
+
+     Read user records buffered by a prior `UsersSyncStart` call.
+
+    Manager (live) call to the wrapper's `UsersSyncRead()`.
+    Must be preceded by `POST UsersSyncStart` on the main x64
+    API to seed the server-side snapshot. Same UnpackObject hazard
+    as `UsersSnapshot` — sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+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,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 100000,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> MT4UserListApiResponse | None:
+    """ Read user-records sync
+
+     Read user records buffered by a prior `UsersSyncStart` call.
+
+    Manager (live) call to the wrapper's `UsersSyncRead()`.
+    Must be preceded by `POST UsersSyncStart` on the main x64
+    API to seed the server-side snapshot. Same UnpackObject hazard
+    as `UsersSnapshot` — sidecar-only.
+
+    **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):
+        limit (int | Unset):  Default: 100000.
+        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,
+client=client,
+limit=limit,
+x_request_timeout=x_request_timeout,
+
+    )).parsed

cplugin_webapi_sdk/_generated/api/mt4_v_2_sidecar_external_command/__init__.py

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