Reference / @getenginex/sdk/query / CoreMutations
CoreMutations
Core mutations, one per write method: m.<namespace>.<method>() returns { mutationKey, mutationFn, invalidates }. Obtained with createMutations.
Properties
auth
readonlyauth: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
readonlydeposits:IdempotentMutationsOf<DepositsApi,"createPix">
PIX deposit (idempotent: accepts { idempotencyKey }).
kyc
readonlykyc:MutationsOf<KycApi,"uploadDocument">
Document upload.
notifications
readonlynotifications:MutationsOf<NotificationsApi,"markAsRead"|"updatePreferences">
Marking a notification as read and preferences.
pixKeys
readonlypixKeys:MutationsOf<PixKeysApi,"add"|"remove"|"setDefault">
Add, remove and default key.
profile
readonlyprofile:MutationsOf<ProfileApi,"update"|"revokeSession">
Profile update and ending sessions.
responsibleGambling
readonlyresponsibleGambling:MutationsOf<ResponsibleGamblingApi,"setLimits"|"selfExclude">
Limits and self-exclusion.
withdrawals
readonlywithdrawals:IdempotentMutationsOf<WithdrawalsApi,"request"|"confirmOtp"> &MutationsOf<WithdrawalsApi,"cancel">
Withdrawal and OTP confirmation (idempotent: they accept { idempotencyKey }) and cancellation.