This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk/query / CoreMutations

CoreMutations ​

Core mutations, one per write method: m.<namespace>.<method>() returns { mutationKey, mutationFn, invalidates }. Obtained with createMutations.

Properties ​

auth ​

readonly auth: MutationsOf<AuthApi, "register" | "login" | "forgotPassword" | "resetPassword" | "verifyEmail" | "resendVerificationEmail" | "verifyPhone" | "resendPhoneVerification" | "lookupCpf" | "saveLead" | "logout" | "changePassword" | "requestPhoneChange" | "confirmPhoneChange" | "enable2fa" | "verify2fa" | "disable2fa">

Sign-up, login/logout, verification, password, phone and 2FA.


deposits ​

readonly deposits: IdempotentMutationsOf<DepositsApi, "createPix">

PIX deposit (idempotent: accepts { idempotencyKey }).


kyc ​

readonly kyc: MutationsOf<KycApi, "uploadDocument">

Document upload.


notifications ​

readonly notifications: MutationsOf<NotificationsApi, "markAsRead" | "updatePreferences">

Marking a notification as read and preferences.


pixKeys ​

readonly pixKeys: MutationsOf<PixKeysApi, "add" | "remove" | "setDefault">

Add, remove and default key.


profile ​

readonly profile: MutationsOf<ProfileApi, "update" | "revokeSession">

Profile update and ending sessions.


responsibleGambling ​

readonly responsibleGambling: MutationsOf<ResponsibleGamblingApi, "setLimits" | "selfExclude">

Limits and self-exclusion.


withdrawals ​

readonly withdrawals: IdempotentMutationsOf<WithdrawalsApi, "request" | "confirmOtp"> & MutationsOf<WithdrawalsApi, "cancel">

Withdrawal and OTP confirmation (idempotent: they accept { idempotencyKey }) and cancellation.