feat: added mutation and function to platform for updating user profile name (#3929)

Co-authored-by: amk-dev <akash.k.mohan98@gmail.com>
Co-authored-by: jamesgeorge007 <jamesgeorge998001@gmail.com>
This commit is contained in:
Nivedin
2024-03-25 14:41:25 +05:30
committed by GitHub
parent 1113c79e20
commit c326f54f7e
7 changed files with 68 additions and 18 deletions

View File

@@ -4,6 +4,7 @@ import { Component } from "vue"
import { getI18n } from "~/modules/i18n"
import * as E from "fp-ts/Either"
import { AxiosRequestConfig } from "axios"
import { GQLError } from "~/helpers/backend/GQLClient"
/**
* A common (and required) set of fields that describe a user.
@@ -229,9 +230,11 @@ export type AuthPlatformDef = {
/**
* Updates the display name of the user
* @param name The new name to set this to.
* @returns An empty promise that is resolved when the operation is complete
* @returns A promise that resolves with the display name update status when the operation is complete
*/
setDisplayName: (name: string) => Promise<void>
setDisplayName: (
name: string
) => Promise<E.Either<GQLError<string>, undefined>>
/**
* Returns the list of allowed auth providers for the platform ( the currently supported ones are GOOGLE, GITHUB, EMAIL, MICROSOFT, SAML )