mywebapi-sdk 0.3.0__py3-none-any.whl

cplugin_webapi_sdk/_generated/api/mt4_v_2_users/post_api_v_2_mt4_trade_platform_users_group_op.py

@@ -0,0 +1,349 @@
+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.boolean_api_response import BooleanApiResponse
+from ...models.mt4_users_group_op import MT4UsersGroupOp
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    *,
+    body:    MT4UsersGroupOp  |     MT4UsersGroupOp  |     MT4UsersGroupOp  | 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)
+
+
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v2/MT4/{trade_platform}/UsersGroupOp".format(trade_platform=quote(str(trade_platform), safe=""),),
+    }
+
+    if isinstance(body, MT4UsersGroupOp):
+        
+        if not isinstance(body, Unset):
+            _kwargs["json"] = body.to_dict()
+
+        headers["Content-Type"] = "application/json-patch+json"
+    if isinstance(body, MT4UsersGroupOp):
+        
+        if not isinstance(body, Unset):
+            _kwargs["json"] = body.to_dict()
+
+        headers["Content-Type"] = "application/json"
+    if isinstance(body, MT4UsersGroupOp):
+        
+        if not isinstance(body, Unset):
+            _kwargs["json"] = body.to_dict()
+
+        headers["Content-Type"] = "application/*+json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> BooleanApiResponse | None:
+    if response.status_code == 200:
+        response_200 = BooleanApiResponse.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[BooleanApiResponse]:
+    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:    MT4UsersGroupOp  |     MT4UsersGroupOp  |     MT4UsersGroupOp  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[BooleanApiResponse]:
+    """ Bulk account operation
+
+     Bulk operation on a list of account logins — change group, leverage, enable/disable, or delete in a
+    single Manager round-trip.
+
+    Manager (live) call. Wraps `UsersGroupOp(GroupCommandInfo, ICollection<int>)`.
+    The body specifies the command and its parameter (NewGroup for
+    SetGroup, Leverage for Leverage; both ignored for Delete/Enable/
+    Disable) plus the list of target logins. The wrapper auto-fills
+    the internal `Len` field from the logins array — clients do
+    not set it.
+
+    Wine x64 safe: the wrapper uses `AllocArraySafe` on the int
+    login array (single contiguous pack, no UnpackObject loop) and
+    `AllocSafe` on the GroupCommandInfo struct.
+
+    Requires Manager or Administrator access rights on the manager
+    account; the wrapper enforces this server-side. Idempotency-Key
+    strongly recommended — bulk Delete / SetGroup operations are
+    destructive on customer-visible state.
+
+    **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 (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+
+    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[BooleanApiResponse]
+     """
+
+
+    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:    MT4UsersGroupOp  |     MT4UsersGroupOp  |     MT4UsersGroupOp  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> BooleanApiResponse | None:
+    """ Bulk account operation
+
+     Bulk operation on a list of account logins — change group, leverage, enable/disable, or delete in a
+    single Manager round-trip.
+
+    Manager (live) call. Wraps `UsersGroupOp(GroupCommandInfo, ICollection<int>)`.
+    The body specifies the command and its parameter (NewGroup for
+    SetGroup, Leverage for Leverage; both ignored for Delete/Enable/
+    Disable) plus the list of target logins. The wrapper auto-fills
+    the internal `Len` field from the logins array — clients do
+    not set it.
+
+    Wine x64 safe: the wrapper uses `AllocArraySafe` on the int
+    login array (single contiguous pack, no UnpackObject loop) and
+    `AllocSafe` on the GroupCommandInfo struct.
+
+    Requires Manager or Administrator access rights on the manager
+    account; the wrapper enforces this server-side. Idempotency-Key
+    strongly recommended — bulk Delete / SetGroup operations are
+    destructive on customer-visible state.
+
+    **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 (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+
+    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:
+        BooleanApiResponse
+     """
+
+
+    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:    MT4UsersGroupOp  |     MT4UsersGroupOp  |     MT4UsersGroupOp  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[BooleanApiResponse]:
+    """ Bulk account operation
+
+     Bulk operation on a list of account logins — change group, leverage, enable/disable, or delete in a
+    single Manager round-trip.
+
+    Manager (live) call. Wraps `UsersGroupOp(GroupCommandInfo, ICollection<int>)`.
+    The body specifies the command and its parameter (NewGroup for
+    SetGroup, Leverage for Leverage; both ignored for Delete/Enable/
+    Disable) plus the list of target logins. The wrapper auto-fills
+    the internal `Len` field from the logins array — clients do
+    not set it.
+
+    Wine x64 safe: the wrapper uses `AllocArraySafe` on the int
+    login array (single contiguous pack, no UnpackObject loop) and
+    `AllocSafe` on the GroupCommandInfo struct.
+
+    Requires Manager or Administrator access rights on the manager
+    account; the wrapper enforces this server-side. Idempotency-Key
+    strongly recommended — bulk Delete / SetGroup operations are
+    destructive on customer-visible state.
+
+    **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 (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+
+    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[BooleanApiResponse]
+     """
+
+
+    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:    MT4UsersGroupOp  |     MT4UsersGroupOp  |     MT4UsersGroupOp  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> BooleanApiResponse | None:
+    """ Bulk account operation
+
+     Bulk operation on a list of account logins — change group, leverage, enable/disable, or delete in a
+    single Manager round-trip.
+
+    Manager (live) call. Wraps `UsersGroupOp(GroupCommandInfo, ICollection<int>)`.
+    The body specifies the command and its parameter (NewGroup for
+    SetGroup, Leverage for Leverage; both ignored for Delete/Enable/
+    Disable) plus the list of target logins. The wrapper auto-fills
+    the internal `Len` field from the logins array — clients do
+    not set it.
+
+    Wine x64 safe: the wrapper uses `AllocArraySafe` on the int
+    login array (single contiguous pack, no UnpackObject loop) and
+    `AllocSafe` on the GroupCommandInfo struct.
+
+    Requires Manager or Administrator access rights on the manager
+    account; the wrapper enforces this server-side. Idempotency-Key
+    strongly recommended — bulk Delete / SetGroup operations are
+    destructive on customer-visible state.
+
+    **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 (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+        body (MT4UsersGroupOp | Unset): v2 request body for `UsersGroupOp` — bulk group-membership
+            / leverage /
+            enable-disable / delete operation across a list of account logins.
+
+    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:
+        BooleanApiResponse
+     """
+
+
+    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_users/post_api_v_2_mt4_trade_platform_users_sync_start.py

@@ -0,0 +1,273 @@
+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.boolean_api_response import BooleanApiResponse
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    trade_platform: UUID,
+    *,
+    timestamp: int | 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["timestamp"] = timestamp
+
+
+    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}/UsersSyncStart".format(trade_platform=quote(str(trade_platform), safe=""),),
+        "params": params,
+    }
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> BooleanApiResponse | None:
+    if response.status_code == 200:
+        response_200 = BooleanApiResponse.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[BooleanApiResponse]:
+    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,
+    timestamp: int | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[BooleanApiResponse]:
+    """ Start user-records sync
+
+     Opens a server-side incremental sync session for user records modified at or after timestamp.
+
+    Manager-live POST (modifies server-side session state). The wrapper
+    supports a follow-up `UsersSyncRead` call that drains the
+    snapshot, but the read-side endpoint is currently deferred under
+    wine x64 (see deferral note above this method). Pass
+    `timestamp=0` to request all user records.
+
+    `timestamp` is Unix epoch seconds (int32) in MT4 server-local
+    time, not UTC. Returns a bare success envelope.
+
+    **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):
+        timestamp (int | 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[BooleanApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+timestamp=timestamp,
+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,
+    timestamp: int | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> BooleanApiResponse | None:
+    """ Start user-records sync
+
+     Opens a server-side incremental sync session for user records modified at or after timestamp.
+
+    Manager-live POST (modifies server-side session state). The wrapper
+    supports a follow-up `UsersSyncRead` call that drains the
+    snapshot, but the read-side endpoint is currently deferred under
+    wine x64 (see deferral note above this method). Pass
+    `timestamp=0` to request all user records.
+
+    `timestamp` is Unix epoch seconds (int32) in MT4 server-local
+    time, not UTC. Returns a bare success envelope.
+
+    **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):
+        timestamp (int | 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:
+        BooleanApiResponse
+     """
+
+
+    return sync_detailed(
+        trade_platform=trade_platform,
+client=client,
+timestamp=timestamp,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    *,
+    client: AuthenticatedClient | Client,
+    timestamp: int | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[BooleanApiResponse]:
+    """ Start user-records sync
+
+     Opens a server-side incremental sync session for user records modified at or after timestamp.
+
+    Manager-live POST (modifies server-side session state). The wrapper
+    supports a follow-up `UsersSyncRead` call that drains the
+    snapshot, but the read-side endpoint is currently deferred under
+    wine x64 (see deferral note above this method). Pass
+    `timestamp=0` to request all user records.
+
+    `timestamp` is Unix epoch seconds (int32) in MT4 server-local
+    time, not UTC. Returns a bare success envelope.
+
+    **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):
+        timestamp (int | 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[BooleanApiResponse]
+     """
+
+
+    kwargs = _get_kwargs(
+        trade_platform=trade_platform,
+timestamp=timestamp,
+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,
+    timestamp: int | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> BooleanApiResponse | None:
+    """ Start user-records sync
+
+     Opens a server-side incremental sync session for user records modified at or after timestamp.
+
+    Manager-live POST (modifies server-side session state). The wrapper
+    supports a follow-up `UsersSyncRead` call that drains the
+    snapshot, but the read-side endpoint is currently deferred under
+    wine x64 (see deferral note above this method). Pass
+    `timestamp=0` to request all user records.
+
+    `timestamp` is Unix epoch seconds (int32) in MT4 server-local
+    time, not UTC. Returns a bare success envelope.
+
+    **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):
+        timestamp (int | 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:
+        BooleanApiResponse
+     """
+
+
+    return (await asyncio_detailed(
+        trade_platform=trade_platform,
+client=client,
+timestamp=timestamp,
+x_request_timeout=x_request_timeout,
+
+    )).parsed

cplugin_webapi_sdk/_generated/api/mt5_v_2_common/__init__.py

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