mywebapi-sdk 0.3.0__py3-none-any.whl

cplugin_webapi_sdk/__init__.py

@@ -0,0 +1,79 @@
+"""CPlugin SaaS WebAPI Python SDK — v2.
+
+Public surface for import::
+
+    from cplugin_webapi_sdk import CPluginWebApiClient, ApiError
+"""
+from .client import CPluginWebApiClient, CPluginWebApiAsyncClient
+from .errors import ApiError
+from .envelope import ApiEnvelope, ApiMeta, ApiErrorBody, PagingMeta
+from .environments import resolve_environment, ResolvedEnvironment, EnvironmentName
+from .auth import ClientCredentialsAuth, BearerAuth, OAuth2TokenError
+from .unwrap import unwrap, unwrap_async, unwrap_with_meta, unwrap_with_meta_async
+from .pagination import (
+    paginate_sync,
+    collect_all_sync,
+    paginate_async,
+    collect_all_async,
+    PageFetcherSync,
+    PageFetcherAsync,
+)
+from .realtime import MT4RealtimeClient, MT5RealtimeClient, SignalRNotInstalledError
+from .flags import parse_flags, format_flags, has_flag, with_flag
+from .timeouts import (
+    ErrorCode,
+    RequestOutcome,
+    is_outcome_unknown,
+    is_safe_to_retry,
+    MIN_REQUEST_TIMEOUT,
+    MAX_REQUEST_TIMEOUT,
+)
+
+__all__ = [
+    # * Primary client classes
+    "CPluginWebApiClient",
+    "CPluginWebApiAsyncClient",
+    # * Error surface
+    "ApiError",
+    # * Timeouts and retries — error codes, X-Request-Outcome values, retry classification
+    "ErrorCode",
+    "RequestOutcome",
+    "is_outcome_unknown",
+    "is_safe_to_retry",
+    "MIN_REQUEST_TIMEOUT",
+    "MAX_REQUEST_TIMEOUT",
+    # * Envelope types (for typed access to response metadata)
+    "ApiEnvelope",
+    "ApiMeta",
+    "ApiErrorBody",
+    "PagingMeta",
+    # * Environment helpers
+    "resolve_environment",
+    "ResolvedEnvironment",
+    "EnvironmentName",
+    # * Auth classes (for custom httpx pipelines)
+    "ClientCredentialsAuth",
+    "BearerAuth",
+    "OAuth2TokenError",
+    # * Unwrap helpers (for use with raw() escape hatch)
+    "unwrap",
+    "unwrap_async",
+    "unwrap_with_meta",
+    "unwrap_with_meta_async",
+    # * Pagination helpers — cursor-based iteration over meta.paging
+    "paginate_sync",
+    "collect_all_sync",
+    "paginate_async",
+    "collect_all_async",
+    "PageFetcherSync",
+    "PageFetcherAsync",
+    # * Flag fields ("Enabled, Password") — user rights, group and symbol flags
+    "parse_flags",
+    "format_flags",
+    "has_flag",
+    "with_flag",
+    # * Real-time SignalR clients (optional signalrcore extra)
+    "MT4RealtimeClient",
+    "MT5RealtimeClient",
+    "SignalRNotInstalledError",
+]

cplugin_webapi_sdk/_generated/__init__.py

@@ -0,0 +1,8 @@
+
+""" A client library for accessing JSON-Pure WebAPI for MT4/MT5 """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

cplugin_webapi_sdk/_generated/api/__init__.py

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

cplugin_webapi_sdk/_generated/api/mt4_v_2_authentication/__init__.py

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

cplugin_webapi_sdk/_generated/api/mt4_v_2_authentication/post_api_v_2_mt4_trade_platform_user_password_check_login.py

@@ -0,0 +1,306 @@
+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,
+    login: int,
+    *,
+    body:    str  |     str  |     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)
+
+
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v2/MT4/{trade_platform}/UserPasswordCheck/{login}".format(trade_platform=quote(str(trade_platform), safe=""),login=quote(str(login), safe=""),),
+    }
+
+    if isinstance(body, str):
+        if not isinstance(body, Unset):
+            _kwargs["json"] = body
+
+        headers["Content-Type"] = "application/json-patch+json"
+    if isinstance(body, str):
+        if not isinstance(body, Unset):
+            _kwargs["json"] = body
+
+        headers["Content-Type"] = "application/json"
+    if isinstance(body, str):
+        if not isinstance(body, Unset):
+            _kwargs["json"] = body
+
+        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,
+    login: int,
+    *,
+    client: AuthenticatedClient | Client,
+    body:    str  |     str  |     str  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[BooleanApiResponse]:
+    r""" Verify account password
+
+     Verify an account password against the MT4 server.
+
+    POST body: the candidate password as a JSON string (e.g. `\"secret123\"`).
+    Returns envelope with bool payload — `true` if MT4 server accepts
+    the password, `false` when wrapper returns InvalidLoginOrPassword
+    (envelope marked as MT4Error with the underlying ResultCode in
+    managerAPICode).
+
+    Read-only operation: no state changes. Idempotency-Key on this endpoint
+    is supported but rarely useful — pin if your retry policy expects the
+    same answer across attempts.
+
+    **Timeout:** 15 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):
+        login (int):
+        x_request_timeout (float | Unset):
+        body (str | Unset):
+        body (str | Unset):
+        body (str | 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,
+login=login,
+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,
+    login: int,
+    *,
+    client: AuthenticatedClient | Client,
+    body:    str  |     str  |     str  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> BooleanApiResponse | None:
+    r""" Verify account password
+
+     Verify an account password against the MT4 server.
+
+    POST body: the candidate password as a JSON string (e.g. `\"secret123\"`).
+    Returns envelope with bool payload — `true` if MT4 server accepts
+    the password, `false` when wrapper returns InvalidLoginOrPassword
+    (envelope marked as MT4Error with the underlying ResultCode in
+    managerAPICode).
+
+    Read-only operation: no state changes. Idempotency-Key on this endpoint
+    is supported but rarely useful — pin if your retry policy expects the
+    same answer across attempts.
+
+    **Timeout:** 15 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):
+        login (int):
+        x_request_timeout (float | Unset):
+        body (str | Unset):
+        body (str | Unset):
+        body (str | 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,
+login=login,
+client=client,
+body=body,
+x_request_timeout=x_request_timeout,
+
+    ).parsed
+
+async def asyncio_detailed(
+    trade_platform: UUID,
+    login: int,
+    *,
+    client: AuthenticatedClient | Client,
+    body:    str  |     str  |     str  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> Response[BooleanApiResponse]:
+    r""" Verify account password
+
+     Verify an account password against the MT4 server.
+
+    POST body: the candidate password as a JSON string (e.g. `\"secret123\"`).
+    Returns envelope with bool payload — `true` if MT4 server accepts
+    the password, `false` when wrapper returns InvalidLoginOrPassword
+    (envelope marked as MT4Error with the underlying ResultCode in
+    managerAPICode).
+
+    Read-only operation: no state changes. Idempotency-Key on this endpoint
+    is supported but rarely useful — pin if your retry policy expects the
+    same answer across attempts.
+
+    **Timeout:** 15 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):
+        login (int):
+        x_request_timeout (float | Unset):
+        body (str | Unset):
+        body (str | Unset):
+        body (str | 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,
+login=login,
+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,
+    login: int,
+    *,
+    client: AuthenticatedClient | Client,
+    body:    str  |     str  |     str  | Unset = UNSET,
+    x_request_timeout: float | Unset = UNSET,
+
+) -> BooleanApiResponse | None:
+    r""" Verify account password
+
+     Verify an account password against the MT4 server.
+
+    POST body: the candidate password as a JSON string (e.g. `\"secret123\"`).
+    Returns envelope with bool payload — `true` if MT4 server accepts
+    the password, `false` when wrapper returns InvalidLoginOrPassword
+    (envelope marked as MT4Error with the underlying ResultCode in
+    managerAPICode).
+
+    Read-only operation: no state changes. Idempotency-Key on this endpoint
+    is supported but rarely useful — pin if your retry policy expects the
+    same answer across attempts.
+
+    **Timeout:** 15 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):
+        login (int):
+        x_request_timeout (float | Unset):
+        body (str | Unset):
+        body (str | Unset):
+        body (str | 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,
+login=login,
+client=client,
+body=body,
+x_request_timeout=x_request_timeout,
+
+    )).parsed