@mywebapi.com/sdk 0.1.0

package/dist/generated/model/usersRights.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+/**
+ * MT5 user permission flags. Values mirror CIMTUser.EnUsersRights.
+ *             Serializes as a string (not a number) via V2JsonContext.UseStringEnumConverter.
+ */
+export type UsersRights = typeof UsersRights[keyof typeof UsersRights];
+export declare const UsersRights: {
+    readonly None: "None";
+    readonly Enabled: "Enabled";
+    readonly Password: "Password";
+    readonly TradeDisabled: "TradeDisabled";
+    readonly Investor: "Investor";
+    readonly Confirmed: "Confirmed";
+    readonly Trailing: "Trailing";
+    readonly Expert: "Expert";
+    readonly Obsolete: "Obsolete";
+    readonly Reports: "Reports";
+    readonly Readonly: "Readonly";
+    readonly ResetPass: "ResetPass";
+    readonly OTPEnabled: "OTPEnabled";
+    readonly SponsoredHosting: "SponsoredHosting";
+    readonly APIEnabled: "APIEnabled";
+    readonly PushNotification: "PushNotification";
+    readonly Technical: "Technical";
+    readonly ExcludeReports: "ExcludeReports";
+};

package/dist/generated/model/watchdogFailoverMode.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+export type WatchdogFailoverMode = typeof WatchdogFailoverMode[keyof typeof WatchdogFailoverMode];
+export declare const WatchdogFailoverMode: {
+    readonly Off: "Off";
+    readonly Most: "Most";
+    readonly Full: "Full";
+};

package/dist/generated/model/watchdogState.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+export type WatchdogState = typeof WatchdogState[keyof typeof WatchdogState];
+export declare const WatchdogState: {
+    readonly Disconnected: "Disconnected";
+    readonly Synchronizing: "Synchronizing";
+    readonly Synchronized: "Synchronized";
+};

package/dist/generated/model/webApiErrorCode.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+/**
+ * Transport-level error classification for v2 responses. Stable across MT4
+ * wrapper versions — clients can branch on this without knowing MT-specific
+ * codes. When ErrorCode == MT4Error, see ManagerCode for the underlying
+ * MT4 ResultCode value.
+ */
+export type WebApiErrorCode = typeof WebApiErrorCode[keyof typeof WebApiErrorCode];
+export declare const WebApiErrorCode: {
+    readonly Ok: "Ok";
+    readonly NoConnect: "NoConnect";
+    readonly Validation: "Validation";
+    readonly MT4Error: "MT4Error";
+    readonly Forbidden: "Forbidden";
+    readonly NotFound: "NotFound";
+    readonly MT5Error: "MT5Error";
+    readonly Internal: "Internal";
+};

package/dist/generated/mt4-v2-authentication.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { BooleanApiResponse, PostUserPasswordSetLoginParams } from './model';
+export type postUserPasswordCheckLoginResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type postUserPasswordCheckLoginResponseSuccess = (postUserPasswordCheckLoginResponse200) & {
+    headers: Headers;
+};
+export type postUserPasswordCheckLoginResponse = (postUserPasswordCheckLoginResponseSuccess);
+export declare const getPostUserPasswordCheckLoginUrl: (tradePlatform: string, login: number) => string;
+/**
+ * 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.
+ * @summary Verify account password
+ */
+export declare const postUserPasswordCheckLogin: (tradePlatform: string, login: number, postUserPasswordCheckLoginBody?: string, options?: RequestInit) => Promise<postUserPasswordCheckLoginResponse>;
+export type postUserPasswordSetLoginResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type postUserPasswordSetLoginResponseSuccess = (postUserPasswordSetLoginResponse200) & {
+    headers: Headers;
+};
+export type postUserPasswordSetLoginResponse = (postUserPasswordSetLoginResponseSuccess);
+export declare const getPostUserPasswordSetLoginUrl: (tradePlatform: string, login: number, params?: PostUserPasswordSetLoginParams) => string;
+/**
+ * Set the account password — Type 1 mutator (direct overwrite).
+ *
+ * POST body: the new password as a JSON string. Optional query params:
+ * `changeInvestor=true` sets the read-only investor password instead
+ * of the primary one; `cleanPubkey=true` resets the public key alongside
+ * the password (caller's RSA-protected secondary auth).
+ *
+ * <br>
+ * This is a Type 1 mutator — full-replace semantics. The wrapper accepts
+ * the new password directly without a read-modify-write loop. There is no
+ * Type 2 ("set only this field, leave the rest alone") variant of password
+ * change because the password is itself a single field — the read step
+ * would be tautological.
+ * <br>
+ * Idempotency-Key is strongly recommended. A retried password change without
+ * the header risks setting it twice (the second call returns success even
+ * though the password is the same), which is harmless but generates audit
+ * noise. With the header, the second call short-circuits to the cached
+ * response.
+ * @summary Set account password
+ */
+export declare const postUserPasswordSetLogin: (tradePlatform: string, login: number, postUserPasswordSetLoginBody?: string, params?: PostUserPasswordSetLoginParams, options?: RequestInit) => Promise<postUserPasswordSetLoginResponse>;

package/dist/generated/mt4-v2-backup-destructive.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { BooleanApiResponse, MT4TradeRestoreInput, MT4TradeRestoreResultListApiResponse, MT4UserRestoreInput, PostBackupRestoreOrdersParams, PostBackupRestoreUsersParams } from './model';
+export type postBackupRestoreUsersResponse200 = {
+    data: BooleanApiResponse;
+    status: 200;
+};
+export type postBackupRestoreUsersResponseSuccess = (postBackupRestoreUsersResponse200) & {
+    headers: Headers;
+};
+export type postBackupRestoreUsersResponse = (postBackupRestoreUsersResponseSuccess);
+export declare const getPostBackupRestoreUsersUrl: (tradePlatform: string, params?: PostBackupRestoreUsersParams) => string;
+/**
+ * Restore user records into the live MT4 database. Destructive — requires `?confirm=true`.
+ *
+ * Manager (live) call to the wrapper's
+ * `BackupRestoreUsers(UserRecord[] users)`. Each input
+ * `MT4UserRestoreInput` is mapped to a fresh `UserRecord`
+ * with the narrow restore field set — secrets, OTP, server-managed
+ * timestamps, and reserved blobs are NOT carried (see DTO docs).
+ * <br>
+ * Idempotency-Key header is <b>strongly recommended</b>: a network
+ * blip during a multi-user restore can leave the client uncertain
+ * whether the write happened. Without the key, retry will double-write.
+ * <br>
+ * Batch cap: 10000 records per call. Larger restores must be split.
+ * @summary Restore users from backup
+ */
+export declare const postBackupRestoreUsers: (tradePlatform: string, mT4UserRestoreInput?: MT4UserRestoreInput[], params?: PostBackupRestoreUsersParams, options?: RequestInit) => Promise<postBackupRestoreUsersResponse>;
+export type postBackupRestoreOrdersResponse200 = {
+    data: MT4TradeRestoreResultListApiResponse;
+    status: 200;
+};
+export type postBackupRestoreOrdersResponseSuccess = (postBackupRestoreOrdersResponse200) & {
+    headers: Headers;
+};
+export type postBackupRestoreOrdersResponse = (postBackupRestoreOrdersResponseSuccess);
+export declare const getPostBackupRestoreOrdersUrl: (tradePlatform: string, params?: PostBackupRestoreOrdersParams) => string;
+/**
+ * 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.
+ * @summary Restore orders from backup
+ */
+export declare const postBackupRestoreOrders: (tradePlatform: string, mT4TradeRestoreInput?: MT4TradeRestoreInput[], params?: PostBackupRestoreOrdersParams, options?: RequestInit) => Promise<postBackupRestoreOrdersResponse>;

package/dist/generated/mt4-v2-backup.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { GetBackupRequestOrdersFileParams, GetBackupRequestUsersFileParams, MT4BackupInfoListApiResponse, MT4TradeListApiResponse, MT4UserListApiResponse } from './model';
+export type getBackupInfoUsersModeResponse200 = {
+    data: MT4BackupInfoListApiResponse;
+    status: 200;
+};
+export type getBackupInfoUsersModeResponseSuccess = (getBackupInfoUsersModeResponse200) & {
+    headers: Headers;
+};
+export type getBackupInfoUsersModeResponse = (getBackupInfoUsersModeResponseSuccess);
+export declare const getGetBackupInfoUsersModeUrl: (tradePlatform: string, mode: number) => string;
+/**
+ * List backup user files available on the MT4 server for a given mode.
+ *
+ * Manager (live) call to the wrapper's
+ * `BackupInfoUsers(int mode)`. Returns the catalog of backup
+ * files (filename, size, mtime) — does NOT touch the files themselves.
+ * Read-only operation: safe to call repeatedly.
+ * <br>`mode` is the server-defined backup mode selector (typical
+ * values: `0` = daily, `1` = weekly — confirm against your
+ * server's `ConBackup` configuration).
+ * @summary List user backup files
+ */
+export declare const getBackupInfoUsersMode: (tradePlatform: string, mode: number, options?: RequestInit) => Promise<getBackupInfoUsersModeResponse>;
+export type getBackupInfoOrdersModeResponse200 = {
+    data: MT4BackupInfoListApiResponse;
+    status: 200;
+};
+export type getBackupInfoOrdersModeResponseSuccess = (getBackupInfoOrdersModeResponse200) & {
+    headers: Headers;
+};
+export type getBackupInfoOrdersModeResponse = (getBackupInfoOrdersModeResponseSuccess);
+export declare const getGetBackupInfoOrdersModeUrl: (tradePlatform: string, mode: number) => string;
+/**
+ * List backup order files available on the MT4 server for a given mode.
+ *
+ * Manager (live) call to the wrapper's
+ * `BackupInfoOrders(int mode)`. Order-side counterpart of
+ * `BackupInfoUsers` — same shape, different catalog.
+ * Read-only operation.
+ * @summary List order backup files
+ */
+export declare const getBackupInfoOrdersMode: (tradePlatform: string, mode: number, options?: RequestInit) => Promise<getBackupInfoOrdersModeResponse>;
+export type getBackupRequestUsersFileResponse200 = {
+    data: MT4UserListApiResponse;
+    status: 200;
+};
+export type getBackupRequestUsersFileResponseSuccess = (getBackupRequestUsersFileResponse200) & {
+    headers: Headers;
+};
+export type getBackupRequestUsersFileResponse = (getBackupRequestUsersFileResponseSuccess);
+export declare const getGetBackupRequestUsersFileUrl: (tradePlatform: string, file: string, params?: GetBackupRequestUsersFileParams) => string;
+/**
+ * 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.
+ * @summary Read users from backup
+ */
+export declare const getBackupRequestUsersFile: (tradePlatform: string, file: string, params?: GetBackupRequestUsersFileParams, options?: RequestInit) => Promise<getBackupRequestUsersFileResponse>;
+export type getBackupRequestOrdersFileResponse200 = {
+    data: MT4TradeListApiResponse;
+    status: 200;
+};
+export type getBackupRequestOrdersFileResponseSuccess = (getBackupRequestOrdersFileResponse200) & {
+    headers: Headers;
+};
+export type getBackupRequestOrdersFileResponse = (getBackupRequestOrdersFileResponseSuccess);
+export declare const getGetBackupRequestOrdersFileUrl: (tradePlatform: string, file: string, params?: GetBackupRequestOrdersFileParams) => string;
+/**
+ * Read trade records out of a backup file (does NOT restore — read-only).
+ *
+ * Manager (live) call to the wrapper's
+ * `BackupRequestOrders(string file, string request)`. Order-side
+ * counterpart of `BackupRequestUsers`. Same caveats:
+ * read-only, full file loaded server-side regardless of `limit`,
+ * destructive restore is a separate (Wave 4b) operation.
+ * @summary Read orders from backup
+ */
+export declare const getBackupRequestOrdersFile: (tradePlatform: string, file: string, params?: GetBackupRequestOrdersFileParams, options?: RequestInit) => Promise<getBackupRequestOrdersFileResponse>;

package/dist/generated/mt4-v2-common.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Generated by orval v8.19.0 🍺
+ * Do not edit manually.
+ * JSON-Pure WebAPI for MT4/MT5
+ * It uses native MetaQuote ManagerAPI for both MT4 and MT5 connection. Plus, it keep pumping connection active, so all *Get calls will run much faster, than *Request.<br/>Here partially used the idea of JSON-Pure API, only HTTP code 200 is acceptable. Other codes signal about errors on server side, which are out of control of client, like wrong parameters, platform unavailability, etc.
+ * OpenAPI spec version: 2.0
+ */
+import type { DateTimeApiResponse, GetJournalRequestParams, MT4CommonApiResponse, MT4ServerLogListApiResponse } from './model';
+export type getServerTimeMT4Response200 = {
+    data: DateTimeApiResponse;
+    status: 200;
+};
+export type getServerTimeMT4ResponseSuccess = (getServerTimeMT4Response200) & {
+    headers: Headers;
+};
+export type getServerTimeMT4Response = (getServerTimeMT4ResponseSuccess);
+export declare const getGetServerTimeMT4Url: (tradePlatform: string) => string;
+/**
+ * Server time of the connected MT4 trade server.
+ *
+ * Smoke-test endpoint exercising the v2 envelope. Returns current MT4
+ * server time wrapped in ApiResponse<DateTime>.
+ * @summary Get server time
+ */
+export declare const getServerTimeMT4: (tradePlatform: string, options?: RequestInit) => Promise<getServerTimeMT4Response>;
+export type getManagerCommonResponse200 = {
+    data: MT4CommonApiResponse;
+    status: 200;
+};
+export type getManagerCommonResponseSuccess = (getManagerCommonResponse200) & {
+    headers: Headers;
+};
+export type getManagerCommonResponse = (getManagerCommonResponseSuccess);
+export declare const getGetManagerCommonUrl: (tradePlatform: string) => string;
+/**
+ * Server-wide MT4 trade server settings (curated subset).
+ *
+ * Returns MT4Common DTO — server name, broker, server version/build,
+ * time zone. Schema is decoupled from the wrapper's ConCommon: v2
+ * clients are protected from MetaQuotes schema changes.
+ * @summary Get manager common settings
+ */
+export declare const getManagerCommon: (tradePlatform: string, options?: RequestInit) => Promise<getManagerCommonResponse>;
+export type getJournalRequestResponse200 = {
+    data: MT4ServerLogListApiResponse;
+    status: 200;
+};
+export type getJournalRequestResponseSuccess = (getJournalRequestResponse200) & {
+    headers: Headers;
+};
+export type getJournalRequestResponse = (getJournalRequestResponseSuccess);
+export declare const getGetJournalRequestUrl: (tradePlatform: string, params?: GetJournalRequestParams) => string;
+/**
+ * Server journal (log) entries for a date window.
+ *
+ * Manager (live) call — round-trips to MT4 server. Returns log entries
+ * in `[from, to]` range filtered by `mode` and an optional
+ * free-text `filter`. Defaults: `mode = Full`, `to = now`
+ * (server time).
+ *
+ * Heavier endpoint — large date windows return large arrays. Pair with
+ * reasonable `from`/`to` bounds; consider `Idempotency-Key`
+ * for retry safety on slow links.
+ * @summary Get server journal
+ */
+export declare const getJournalRequest: (tradePlatform: string, params?: GetJournalRequestParams, options?: RequestInit) => Promise<getJournalRequestResponse>;