Patreon.API.V2.Resource.User (patreon v0.2.0)
Link to this section Summary
Link to this section Types
Specs
t() :: %Patreon.API.V2.Resource.User{ about: String.t() | nil, can_see_nsfw: boolean() | nil, created: DateTime.t() | nil, email: String.t() | nil, first_name: String.t() | nil, full_name: String.t() | nil, hide_pledges: boolean() | nil, id: String.t(), image_url: String.t() | nil, included: %{ campaign: Patreon.API.V2.Resource.Campaign.t() | nil, memberships: any() | [] }, is_email_verified: boolean() | nil, last_name: String.t() | nil, like_count: integer() | nil, social_connections: Patreon.API.V2.Resource.SocialConnections.t() | nil, thumb_url: String.t() | nil, url: String.t() | nil, vanity: String.t() | nil }
Represents a Patreon user.
:about
- The user's about text, which appears on their profile.:can_see_nsfw
-true
if this user can view nsfw content.:created
- Datetime of this user's account creation.:email
- The user's email address. Requires certain scopes to access. See the scopes section of the patreon API documentaiton.:first_name
- The users first name.:full_name
- The users full name.:hide_pledges
-true
if the user has chosen to keep private which creators they pledge to.:image_url
- The user's profile picture URL, scaled to width 400px.:is_email_verified
-true
if the user has confirmed their email.:last_name
- The users last name.:like_count
- How many posts the user has liked.:social_connections
- Mapping from user's connected app names to external user id on the respective app.:thumb_url
- The user's profile picture URL, scaled to a square of size 100x100px.:url
- URL of this user's creator or patron profile.:vanity
- The public "username" of the user.
Link to this section Functions
Link to this function
add_includes(user, includes)
Link to this function
from_response(map)
Specs
from_response(%{data: map(), included: [map()]}) :: %Patreon.API.V2.Resource.User{ about: term(), can_see_nsfw: term(), created: term(), email: term(), first_name: term(), full_name: term(), hide_pledges: term(), id: term(), image_url: term(), included: term(), is_email_verified: term(), last_name: term(), like_count: term(), social_connections: term(), thumb_url: term(), url: term(), vanity: term() }
from_response(%{data: map()}) :: %Patreon.API.V2.Resource.User{ about: term(), can_see_nsfw: term(), created: term(), email: term(), first_name: term(), full_name: term(), hide_pledges: term(), id: term(), image_url: term(), included: term(), is_email_verified: term(), last_name: term(), like_count: term(), social_connections: term(), thumb_url: term(), url: term(), vanity: term() }
Link to this function
opts_to_query(include_fields)
Link to this function