Interface UpdateAccountInfoPayload

interface UpdateAccountInfoPayload {
    approvedSignInMethods?: {
        addresses?: {
            address: string;
            scopes: OAuthScopeDetails[];
        }[];
        discord?: {
            discriminator?: string;
            id: string;
            scopes: OAuthScopeDetails[];
            username: string;
        };
        github?: {
            id: string;
            scopes: OAuthScopeDetails[];
            username: string;
        };
        google?: {
            id: string;
            scopes: OAuthScopeDetails[];
            username: string;
        };
        passwords?: {
            password?: string;
            passwordHash: string;
            salt: string;
            scopes: OAuthScopeDetails[];
        }[];
        twitter?: {
            id: string;
            scopes: OAuthScopeDetails[];
            username: string;
        };
    };
    bannerImage?: string;
    customLinks?: iCustomLink[];
    customPages?: {
        attestations: iCustomListPage[];
        badges: iCustomPage<NumberType>[];
        lists: iCustomListPage[];
    };
    discord?: string;
    github?: string;
    hiddenBadges?: iBatchBadgeDetails<NumberType>[];
    hiddenLists?: string[];
    notifications?: {
        antiPhishingCode?: string;
        discord?: {
            discriminator: undefined | string;
            id: string;
            username: string;
        };
        email?: string;
        preferences?: {
            claimAlerts?: boolean;
            ignoreIfInitiator?: boolean;
            listActivity?: boolean;
            transferActivity?: boolean;
        };
    };
    profilePicImageFile?: any;
    profilePicUrl?: string;
    readme?: string;
    seenActivity?: NumberType;
    socialConnections?: iSocialConnections<NumberType>;
    telegram?: string;
    twitter?: string;
    username?: string;
    watchlists?: {
        attestations: iCustomListPage[];
        badges: iCustomPage<NumberType>[];
        lists: iCustomListPage[];
    };
}

Properties

approvedSignInMethods? bannerImage? customLinks? customPages? discord? github? hiddenBadges? hiddenLists? notifications? profilePicImageFile? profilePicUrl? readme? seenActivity? socialConnections? telegram? twitter? username? watchlists?

Properties

OptionalapprovedSignInMethods

approvedSignInMethods?: {
    addresses?: {
        address: string;
        scopes: OAuthScopeDetails[];
    }[];
    discord?: {
        discriminator?: string;
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    github?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    google?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
    passwords?: {
        password?: string;
        passwordHash: string;
        salt: string;
        scopes: OAuthScopeDetails[];
    }[];
    twitter?: {
        id: string;
        scopes: OAuthScopeDetails[];
        username: string;
    };
}

Approved sign in methods. Only returned if user is authenticated with full access.

OptionalbannerImage

bannerImage?: string

The banner image URL.

OptionalcustomLinks

customLinks?: iCustomLink[]

Custom URL links to display on the user's portfolio.

OptionalcustomPages

customPages?: {
    attestations: iCustomListPage[];
    badges: iCustomPage<NumberType>[];
    lists: iCustomListPage[];
}

An array of custom pages on the user's portolio. Used to customize, sort, and group badges / lists into pages.

Optionaldiscord

discord?: string

The Discord username.

Optionalgithub

github?: string

The GitHub username.

OptionalhiddenBadges

hiddenBadges?: iBatchBadgeDetails<NumberType>[]

The badges to hide and not view for this profile's portfolio

OptionalhiddenLists

hiddenLists?: string[]

The lists to hide and not view for this profile's portfolio

Optionalnotifications

notifications?: {
    antiPhishingCode?: string;
    discord?: {
        discriminator: undefined | string;
        id: string;
        username: string;
    };
    email?: string;
    preferences?: {
        claimAlerts?: boolean;
        ignoreIfInitiator?: boolean;
        listActivity?: boolean;
        transferActivity?: boolean;
    };
}

The notification preferences for the user. Will only be returned if user is authenticated with full access.

OptionalprofilePicImageFile

profilePicImageFile?: any

The profile picture image file to set. We will then upload to our CDN.

OptionalprofilePicUrl

profilePicUrl?: string

The profile picture URL.

Optionalreadme

readme?: string

The README details (markdown supported).

OptionalseenActivity

seenActivity?: NumberType

The last seen activity timestamp.

OptionalsocialConnections

socialConnections?: iSocialConnections<NumberType>

The social connections for the user. Only returned if user is authenticated with full access.

Optionaltelegram

telegram?: string

The Telegram username.

Optionaltwitter

twitter?: string

The Twitter username.

Optionalusername

username?: string

The username.

Optionalwatchlists

watchlists?: {
    attestations: iCustomListPage[];
    badges: iCustomPage<NumberType>[];
    lists: iCustomListPage[];
}

The watchlist of badges / lists

Settings

Member Visibility

On This Page

Properties