Function: getFriendshipStatus()

function getFriendshipStatus(client, pk): Promise<{
[key: string]: unknown;
  blocking?: boolean;
  followed_by?: boolean;
  following?: boolean;
  incoming_request?: boolean;
  is_bestie?: boolean;
  is_muting_reel?: boolean;
  is_private?: boolean;
  is_restricted?: boolean;
  muting?: boolean;
  outgoing_request?: boolean;
}>;

Reads the relationship with a user by id. friendships/show/ returns the status fields at the top level, so the whole response is validated.

Parameters

Parameter	Type
client	PrivateClient
pk	string

Returns

Promise<{ [key: string]: unknown; blocking?: boolean; followed_by?: boolean; following?: boolean; incoming_request?: boolean; is_bestie?: boolean; is_muting_reel?: boolean; is_private?: boolean; is_restricted?: boolean; muting?: boolean; outgoing_request?: boolean; }>