psn-api
Version:
A well-tested library that lets you get trophy, user, and game data from the PlayStation Network.
16 lines (15 loc) • 1.03 kB
TypeScript
import type { AuthorizationPayload, ProfileFromUserNameResponse } from "../models";
/**
* A call to this function will retrieve the profile of the username being requested.
* If the user cannot be found (either due to non-existence or privacy settings),
* an error will be thrown.
*
* This is a legacy API endpoint function. If you are just trying to get a user's
* account ID, [`makeUniversalSearch()`](https://psn-api.achievements.app/api-docs/universal-search#makeuniversalsearch)
* is recommended instead. This endpoint is here because it can return interesting
* presence information when the user is playing on a legacy console such as a PS3.
*
* @param authorization An object containing your access token, typically retrieved with `exchangeAccessCodeForAuthTokens()`.
* @param userName The username for the user you wish to retrieve a profile for.
*/
export declare const getProfileFromUserName: (authorization: AuthorizationPayload, userName: string) => Promise<ProfileFromUserNameResponse>;