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

    Interface SearchFilters

    Filters accepted by MembersResource.search.

    Most callers pass these as keyword arguments directly to search(); the SDK serializes them to query parameters for you.

    interface SearchFilters {
        sport?: string | readonly string[];
        name?: string;
        memberId?: string | number;
        city?: string;
        state?: string;
        country?: string;
        zip?: string;
        location?: string;
        gender?: Gender | "male" | "female" | "other" | "unknown";
        vairifiedOnly?: boolean;
        wheelchair?: boolean;
        ratingMin?: number;
        ratingMax?: number;
        age?: number;
        ageMin?: number;
        ageMax?: number;
        sortBy?: string;
        sortOrder?: "asc" | "desc";
        pageSize?: number;
        maxResults?: number;
    }
    Index

    Properties

    sport? name? memberId? city? state? country? zip? location? gender? vairifiedOnly? wheelchair? ratingMin? ratingMax? age? ageMin? ageMax? sortBy? sortOrder? pageSize? maxResults?

    Properties

    sport?: string | readonly string[]

    Sport code (e.g. 'pickleball') or list of codes.

    name?: string

    Partial name match (first or last).

    memberId?: string | number

    Exact numeric member ID.

    city?: string
    state?: string
    country?: string
    zip?: string
    location?: string
    gender?: Gender | "male" | "female" | "other" | "unknown"
    vairifiedOnly?: boolean

    When true, only return verified players.

    wheelchair?: boolean

    When true, only return wheelchair players.

    ratingMin?: number

    Lower rating bound (2.0–8.0).

    ratingMax?: number

    Upper rating bound (2.0–8.0).

    age?: number

    Exact age.

    ageMin?: number

    Lower age bound.

    ageMax?: number

    Upper age bound.

    sortBy?: string
    sortOrder?: "asc" | "desc"
    pageSize?: number

    Page size requested per HTTP request (server cap 100). Default 20.

    maxResults?: number

    Maximum total results to iterate. When set, the async iterator stops after yielding this many items, regardless of page count.

    Settings

    Member Visibility

    On This Page

    Properties