mywebapi-sdk 0.3.0__py3-none-any.whl

cplugin_webapi_sdk/_generated/api/mt4_v_2_online/get_api_v_2_mt4_trade_platform_online_request.py

@@ -0,0 +1,276 @@
+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_online_list_api_response import MT4OnlineListApiResponse
+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}/OnlineRequest".format(trade_platform=quote(str(trade_platform), safe=""),),
+        "params": params,
+    }
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MT4OnlineListApiResponse | None:
+    if response.status_code == 200:
+        response_200 = MT4OnlineListApiResponse.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[MT4OnlineListApiResponse]:
+    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[MT4OnlineListApiResponse]:
+    """ List online sessions (live)
+
+     Live snapshot of every currently-online session, fetched from the MT4 server (Manager round-trip —
+    not pump cache).
+
+    Manager (live) counterpart to `OnlineGet`. Useful when the pump
+    cache hasn't warmed yet, when staleness is unacceptable, or as a
+    reconciliation pass against the pump snapshot. Heavier than
+    `OnlineGet`: every call hits the MT4 server. Paged the same way
+    for caller symmetry — cursor is the trailing login (ascending).
+
+    **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[MT4OnlineListApiResponse]
+     """
+
+
+    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,
+
+) -> MT4OnlineListApiResponse | None:
+    """ List online sessions (live)
+
+     Live snapshot of every currently-online session, fetched from the MT4 server (Manager round-trip —
+    not pump cache).
+
+    Manager (live) counterpart to `OnlineGet`. Useful when the pump
+    cache hasn't warmed yet, when staleness is unacceptable, or as a
+    reconciliation pass against the pump snapshot. Heavier than
+    `OnlineGet`: every call hits the MT4 server. Paged the same way
+    for caller symmetry — cursor is the trailing login (ascending).
+
+    **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:
+        MT4OnlineListApiResponse
+     """
+
+
+    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[MT4OnlineListApiResponse]:
+    """ List online sessions (live)
+
+     Live snapshot of every currently-online session, fetched from the MT4 server (Manager round-trip —
+    not pump cache).
+
+    Manager (live) counterpart to `OnlineGet`. Useful when the pump
+    cache hasn't warmed yet, when staleness is unacceptable, or as a
+    reconciliation pass against the pump snapshot. Heavier than
+    `OnlineGet`: every call hits the MT4 server. Paged the same way
+    for caller symmetry — cursor is the trailing login (ascending).
+
+    **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[MT4OnlineListApiResponse]
+     """
+
+
+    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,
+
+) -> MT4OnlineListApiResponse | None:
+    """ List online sessions (live)
+
+     Live snapshot of every currently-online session, fetched from the MT4 server (Manager round-trip —
+    not pump cache).
+
+    Manager (live) counterpart to `OnlineGet`. Useful when the pump
+    cache hasn't warmed yet, when staleness is unacceptable, or as a
+    reconciliation pass against the pump snapshot. Heavier than
+    `OnlineGet`: every call hits the MT4 server. Paged the same way
+    for caller symmetry — cursor is the trailing login (ascending).
+
+    **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:
+        MT4OnlineListApiResponse
+     """
+
+
+    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_plugins/__init__.py

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

cplugin_webapi_sdk/_generated/api/mt4_v_2_plugins/post_api_v_2_mt4_trade_platform_external_command_json.py

@@ -0,0 +1,309 @@
+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.json_node_api_response import JsonNodeApiResponse
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    *,
+    body: Any,
+    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": "post",
+        "url": "/api/v2/MT4/{trade_platform}/ExternalCommandJSON".format(trade_platform=quote(str(trade_platform), safe=""),),
+    }
+
+    _kwargs["json"] = body
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> JsonNodeApiResponse | None:
+    if response.status_code == 200:
+        response_200 = JsonNodeApiResponse.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[JsonNodeApiResponse]:
+    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: Any,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[JsonNodeApiResponse]:
+    """ Send plugin command (JSON)
+
+     Plugin custom-command channel with JSON payload in both directions.
+
+    Manager (live) call wrapping `ExternalCommandJSON`. The MT4
+    server forwards the body to whichever installed plugin claims the
+    command first; the first plugin returning `RET_OK` wins and its
+    response becomes the v2 payload. The request body is sent verbatim
+    (no field renaming, no schema enforcement) so the plugin author
+    owns the over-the-wire contract on both ends.
+
+    The wrapper trio (`ExternalCommand<TIn,TOut>` for binary
+    marshal, `ExternalCommandCustom<T>` for caller-supplied
+    serializer) is intentionally not exposed in v2 — those variants
+    require compile-time struct layouts shared between client and
+    plugin, which a REST surface cannot guarantee. Plugin developers
+    who need binary transport should keep using the wrapper directly
+    from the WebAPI process or build a dedicated binary endpoint.
+
+    Idempotency-Key is strongly recommended — plugins may have side
+    effects, and the channel itself gives no read-modify-write
+    semantics.
+
+    **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):
+        x_request_timeout (float | Unset):
+        body (Any): Any JSON value.
+
+    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[JsonNodeApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+body=body,
+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: Any,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> JsonNodeApiResponse | None:
+    """ Send plugin command (JSON)
+
+     Plugin custom-command channel with JSON payload in both directions.
+
+    Manager (live) call wrapping `ExternalCommandJSON`. The MT4
+    server forwards the body to whichever installed plugin claims the
+    command first; the first plugin returning `RET_OK` wins and its
+    response becomes the v2 payload. The request body is sent verbatim
+    (no field renaming, no schema enforcement) so the plugin author
+    owns the over-the-wire contract on both ends.
+
+    The wrapper trio (`ExternalCommand<TIn,TOut>` for binary
+    marshal, `ExternalCommandCustom<T>` for caller-supplied
+    serializer) is intentionally not exposed in v2 — those variants
+    require compile-time struct layouts shared between client and
+    plugin, which a REST surface cannot guarantee. Plugin developers
+    who need binary transport should keep using the wrapper directly
+    from the WebAPI process or build a dedicated binary endpoint.
+
+    Idempotency-Key is strongly recommended — plugins may have side
+    effects, and the channel itself gives no read-modify-write
+    semantics.
+
+    **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):
+        x_request_timeout (float | Unset):
+        body (Any): Any JSON value.
+
+    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:
+        JsonNodeApiResponse
+     """
+
+
+    return sync_detailed(
+        trade_platform=trade_platform,
+client=client,
+body=body,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    body: Any,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[JsonNodeApiResponse]:
+    """ Send plugin command (JSON)
+
+     Plugin custom-command channel with JSON payload in both directions.
+
+    Manager (live) call wrapping `ExternalCommandJSON`. The MT4
+    server forwards the body to whichever installed plugin claims the
+    command first; the first plugin returning `RET_OK` wins and its
+    response becomes the v2 payload. The request body is sent verbatim
+    (no field renaming, no schema enforcement) so the plugin author
+    owns the over-the-wire contract on both ends.
+
+    The wrapper trio (`ExternalCommand<TIn,TOut>` for binary
+    marshal, `ExternalCommandCustom<T>` for caller-supplied
+    serializer) is intentionally not exposed in v2 — those variants
+    require compile-time struct layouts shared between client and
+    plugin, which a REST surface cannot guarantee. Plugin developers
+    who need binary transport should keep using the wrapper directly
+    from the WebAPI process or build a dedicated binary endpoint.
+
+    Idempotency-Key is strongly recommended — plugins may have side
+    effects, and the channel itself gives no read-modify-write
+    semantics.
+
+    **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):
+        x_request_timeout (float | Unset):
+        body (Any): Any JSON value.
+
+    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[JsonNodeApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+body=body,
+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: Any,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> JsonNodeApiResponse | None:
+    """ Send plugin command (JSON)
+
+     Plugin custom-command channel with JSON payload in both directions.
+
+    Manager (live) call wrapping `ExternalCommandJSON`. The MT4
+    server forwards the body to whichever installed plugin claims the
+    command first; the first plugin returning `RET_OK` wins and its
+    response becomes the v2 payload. The request body is sent verbatim
+    (no field renaming, no schema enforcement) so the plugin author
+    owns the over-the-wire contract on both ends.
+
+    The wrapper trio (`ExternalCommand<TIn,TOut>` for binary
+    marshal, `ExternalCommandCustom<T>` for caller-supplied
+    serializer) is intentionally not exposed in v2 — those variants
+    require compile-time struct layouts shared between client and
+    plugin, which a REST surface cannot guarantee. Plugin developers
+    who need binary transport should keep using the wrapper directly
+    from the WebAPI process or build a dedicated binary endpoint.
+
+    Idempotency-Key is strongly recommended — plugins may have side
+    effects, and the channel itself gives no read-modify-write
+    semantics.
+
+    **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):
+        x_request_timeout (float | Unset):
+        body (Any): Any JSON value.
+
+    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:
+        JsonNodeApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+client=client,
+body=body,
+x_request_timeout=x_request_timeout,
+
+    )).parsed

cplugin_webapi_sdk/_generated/api/mt4_v_2_prices/__init__.py

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