Function searchEmails

Search for Email records in the database.

  • searchEmails(params): Promise<QueryResult<{
        EntityMap: {
            email: Email;
            user: User;
        };
        HashKey: "hashKey";
        RangeKey: "rangeKey";
        ShardedKeys: NonNullable<"beneficiaryHashKey" | "userHashKey">;
        TranscodedProperties: NonNullable<
            | "email"
            | "created"
            | "userId"
            | "beneficiaryId"
            | "firstNameCanonical"
            | "lastNameCanonical"
            | "phone"
            | "updated">;
        TranscodeMap: DefaultTranscodeMap;
        UnshardedKeys: NonNullable<"firstNameRangeKey" | "lastNameRangeKey">;
    }>>

  • Parameters

    Returns Promise<QueryResult<{
        EntityMap: {
            email: Email;
            user: User;
        };
        HashKey: "hashKey";
        RangeKey: "rangeKey";
        ShardedKeys: NonNullable<"beneficiaryHashKey" | "userHashKey">;
        TranscodedProperties: NonNullable<
            | "email"
            | "created"
            | "userId"
            | "beneficiaryId"
            | "firstNameCanonical"
            | "lastNameCanonical"
            | "phone"
            | "updated">;
        TranscodeMap: DefaultTranscodeMap;
        UnshardedKeys: NonNullable<"firstNameRangeKey" | "lastNameRangeKey">;
    }>>

Settings