Vairified TypeScript SDK - v0.3.1
    Preparing search index...

    Class Member

    A partner-facing player record.

    Returned by MembersResource.get (full detail, requires an active OAuth connection) and MembersResource.search (limited detail for public search).

    Rating data lives under sport — keyed by sport code. The backend returns only the sports the player has ratings in, or only the sports requested via the sport= query filter. Use ratingFor to fetch the primary rating for a specific sport with a sensible default.

    Index

    Accessors

    • get sports(): readonly string[]

      The list of sport codes this player has ratings in.

      Returns readonly string[]

    Constructors

    Methods

    • Primary rating for a given sport.

      Parameters

      • sport: string = 'pickleball'

        Sport code — defaults to 'pickleball'.

      Returns number | null

      The primary rating value, or null if the player has no ratings for that sport.

    • Get a specific rating split for a sport.

      Parameters

      • key: string

        Split key (e.g. 'overall-open').

      • sport: string = 'pickleball'

        Sport code — defaults to 'pickleball'.

      Returns RatingSplitWire | null

    Properties

    memberId: number
    id: string | null
    firstName: string
    lastName: string
    fullName: string
    displayName: string
    age: number | null
    city: string | null
    state: string | null
    zip: string | null
    country: string | null
    gender: Gender | null
    activeLeagues: readonly string[] | null
    email: string | null
    grantedScopes: readonly string[] | null