Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthUserRoute

Hierarchy

  • AuthUserRoute

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

disabled

disabled: string[] = ['get', 'patch']

endpoint

endpoint: string = "/auth/user"

Methods

get

  • get(req: { data: { user: UserObject } }): UserInfo

patch

  • patch(req: { body: { additionalData?: Record<string, unknown>; currentPassword?: undefined | string; newPassword?: undefined | string; privately?: string | string[]; profile?: UserEditableProfile; publicly?: string | string[]; settings?: Record<string, unknown>; username?: undefined | string }; data: { user: UserObject } }): UserInfo

  • Update auth user data

    Parameters

    • req: { body: { additionalData?: Record<string, unknown>; currentPassword?: undefined | string; newPassword?: undefined | string; privately?: string | string[]; profile?: UserEditableProfile; publicly?: string | string[]; settings?: Record<string, unknown>; username?: undefined | string }; data: { user: UserObject } }
      • body: { additionalData?: Record<string, unknown>; currentPassword?: undefined | string; newPassword?: undefined | string; privately?: string | string[]; profile?: UserEditableProfile; publicly?: string | string[]; settings?: Record<string, unknown>; username?: undefined | string }
        • Optional additionalData?: Record<string, unknown>
        • Optional currentPassword?: undefined | string
        • Optional newPassword?: undefined | string
        • Optional privately?: string | string[]
        • Optional profile?: UserEditableProfile
        • Optional publicly?: string | string[]
        • Optional settings?: Record<string, unknown>
        • Optional username?: undefined | string
      • data: { user: UserObject }

    Returns UserInfo

Generated using TypeDoc