Class User

constructor

• new User(__namedParameters: { sessionData: SessionsResponse | null }): User

  Parameters

  • __namedParameters: { sessionData: SessionsResponse | null }

  Returns User

sessionData

StaticallowedUserTypes

StaticcurrentUser

address2

• get address2(): string | null

  Returns string | null

bearerToken

• get bearerToken(): string | null

  Returns string | null

county

• get county(): string | null

  Returns string | null

displayAddress

• get displayAddress(): string | null

  Returns string | null

email

• get email(): string | null

  Returns string | null

encryptedCookieToken

• get encryptedCookieToken(): string | null

  Returns string | null

firstName

• get firstName(): string | null

  Returns string | null

id

• get id(): number | null

  Returns number | null

isLandlord

• get isLandlord(): boolean

  Returns boolean

isLettingsApplicant

• get isLettingsApplicant(): boolean

  Returns boolean

isOptedInForMarketing

• get isOptedInForMarketing(): boolean

  Returns boolean

isSalesApplicant

• get isSalesApplicant(): boolean

  Returns boolean

isVendor

• get isVendor(): boolean

  Returns boolean

lastName

• get lastName(): string | null

  Returns string | null

optedInForMarketingAt

• get optedInForMarketingAt(): string | null

  Returns string | null

postcode

• get postcode(): string | null

  Returns string | null

refreshToken

• get refreshToken(): string | null

  Returns string | null

savedProperties

• get savedProperties(): any

  Returns any

savedSearches

• get savedSearches(): any

  Returns any

streetAddress

• get streetAddress(): string | null

  Returns string | null

telHome

• get telHome(): string | null

  Returns string | null

telMobile

• get telMobile(): string | null

  Returns string | null

tokenExpiry

• get tokenExpiry(): string | null

  Returns string | null

town

• get town(): string | null

  Returns string | null

addSavedProperty

• addSavedProperty(id: number | null): Promise<any>

  Parameters

  • id: number | null

  Returns Promise<any>

addSavedSearch

• addSavedSearch(
      __namedParameters: {
          channel: string;
          placeId?: string | null;
          searchFragment: string;
      },
  ): Promise<SearchesAPIResponse>

  Parameters

  • __namedParameters: { channel: string; placeId?: string | null; searchFragment: string }

    • channel: string

      Either 'sales' or 'lettings'

    • OptionalplaceId?: string | null

    • searchFragment: string

      The search path, e.g. from-3-bed/up-to-5-bed/from-300000/up-to-500000

  Returns Promise<SearchesAPIResponse>

removeSavedProperty

• removeSavedProperty(id: number | null): Promise<any>

  Parameters

  • id: number | null

  Returns Promise<any>

removeSavedSearch

• removeSavedSearch(id: number): Promise<SearchesAPIResponse>

  Parameters

  • id: number

  Returns Promise<SearchesAPIResponse>

update

• update(
      params: UserUpdateSnakeParams,
  ): Promise<
      | { errors: string[]; response: null }
      | { errors: null; response: UserUpdateResponse },
  >

  Parameters

  • params: UserUpdateSnakeParams

  Returns Promise<
      | { errors: string[]; response: null }
      | { errors: null; response: UserUpdateResponse },
  >

updateMarketingPreferences

• updateMarketingPreferences(
      preferences: MarketingPreferences,
  ): Promise<
      | { errors: { status: number }[]; response: null }
      | { errors: null; response: MarketingPreferencesResponse },
  >

  Parameters

  • preferences: MarketingPreferences

  Returns Promise<
      | { errors: { status: number }[]; response: null }
      | { errors: null; response: MarketingPreferencesResponse },
  >

updateSavedSearch

• updateSavedSearch(
      id: number,
      updatedSearch: SavedSearch,
  ): Promise<SearchesAPIResponse>

  Parameters

  • id: number
  • updatedSearch: SavedSearch

  Returns Promise<SearchesAPIResponse>

Staticcurrent

• current(
      session: { encryptedCookieToken: string | undefined },
  ): Promise<User | null>

  This will return the currently signed in user if it is present.

  The Session object returned by getServerSession from next-auth must be passed.

  Parameters

  • session: { encryptedCookieToken: string | undefined }

  Returns Promise<User | null>

  Example

   const session = await getServerSession(authOptions);
   const user = await User.current(session);
  Copy

StaticpasswordResetCreate

• passwordResetCreate(
      params: { email: string },
  ): Promise<{ errors: ModelError[] | null; message: string | null }>

  Parameters

  • params: { email: string }

  Returns Promise<{ errors: ModelError[] | null; message: string | null }>

StaticpasswordResetUpdate

• passwordResetUpdate(
      params: PasswordResetUpdateParams,
  ): Promise<
      | { errors: { message: string }[]; message: null }
      | { errors: { message: string; status: number }[]; message: null }
      | { errors: null; message: string },
  >

  Parameters

  • params: PasswordResetUpdateParams

  Returns Promise<
      | { errors: { message: string }[]; message: null }
      | { errors: { message: string; status: number }[]; message: null }
      | { errors: null; message: string },
  >

Staticregister

• register(__namedParameters: UserCreateParams): Promise<RegisterResponse>

  Creates a new user and corresponding lead. Does not sign the user in.

  Parameters

  • __namedParameters: UserCreateParams

  Returns Promise<RegisterResponse>

  Example

  await User.register({
    email: 'myemail@example.com',
    password: 'abc123',
    passwordConfirmation: 'abc123',
    firstName: 'Testuser',
    lastName: 'Testuser',
    agencyId: 12345,
    optInMarketing: false,
    optInTerms: true,
  });
  Copy

  User registration requires a Bearer token (app verification) via production users api, regardless of the environement. This is handled in the users-api-user-helper.ts.

StaticsignIn

• signIn(
      __namedParameters: { email: string; password: string },
  ): Promise<User | null>

  Creates a new user session and instantiates and returns a new User.

  Returns null if sign in was unsuccessful.

  Parameters

  • __namedParameters: { email: string; password: string }

  Returns Promise<User | null>

  Example

  const user = await User.signIn({ email: 'myemail@example.com', password: 'abc123' });
  Copy

StaticverifySession

• verifySession(encryptedCookieToken: string): Promise<User | null>

  Front end user session verification requires a Bearer token (app verification) via staging users api if in a staging environment. This differs from other flows that always require a Bearer token from production, regardless of environment. This is handled in the users-api-session-helper.ts.

  Parameters

  • encryptedCookieToken: string

  Returns Promise<User | null>