Patreon.API.V2.Oauth2 (patreon v0.2.0)

Link to this section Summary

Link to this section Types

Link to this type

get_campaign_opts()

Specs

get_campaign_opts() ::
  {:campaign, [] | [valid_campaign_resource_fields(), ...]}
  | {:tiers, []}
  | {:creator, []}
  | {:benefits, []}
  | {:goals, []}
Link to this type

get_identity_opts()

Specs

get_identity_opts() ::
  {:user, [] | [valid_user_resource_fields(), ...]}
  | {:campaign, [] | [valid_campaign_resource_fields(), ...]}
  | {:memberships, [] | [valid_member_resource_fields(), ...]}
Link to this type

option_test()

Specs

option_test() :: [:a | :b | :c | :d]
Link to this type

user_option_test()

Specs

user_option_test() :: :about | :created
Link to this type

valid_campaign_resource_fields()

Specs

valid_campaign_resource_fields() ::
  :created_at
  | :creation_name
  | :discord_server_id
  | :google_analytics_id
  | :has_rss
  | :has_sent_rss_notify
  | :image_small_url
  | :image_url
  | :is_charged_immediately
  | :is_monthly
  | :is_nsfw
  | :main_video_embed
  | :main_video_url
  | :one_liner
  | :patron_count
  | :pay_per_name
  | :pledge_url
  | :published_at
  | :rss_artwork_url
  | :rss_feed_title
  | :show_earnings
  | :summary
  | :thanks_embed
  | :thanks_msg
  | :thanks_video_url
  | :url
  | :vanity
Link to this type

valid_member_resource_fields()

Specs

valid_member_resource_fields() ::
  :campaign_lifetime_support_cents
  | :currently_entitled_amount_cents
  | :email
  | :full_name
  | :is_follower
  | :last_charge_date
  | :last_charge_status
  | :lifetime_support_cents
  | :next_charge_date
  | :note
  | :patreon_status
  | :pledge_candence
  | :pledge_relationship_start
  | :will_pay_amount_cents
Link to this type

valid_user_resource_fields()

Specs

valid_user_resource_fields() ::
  :about
  | :can_see_nsfw
  | :created
  | :email
  | :first_name
  | :full_name
  | :hide_pledges
  | :image_url
  | :included
  | :is_email_verified
  | :last_name
  | :like_count
  | :social_connections
  | :thumb_url
  | :url
  | :vanity

Allowed fields for querying patreons User resource

Link to this section Functions

Link to this function

get_campaigns( oauth2_token, include_fields \\ [ campaign: [ :created_at, :creation_name, :discord_server_id, :google_analytics_id, :has_rss, :has_sent_rss_notify, :image_small_url, :image_url, :is_charged_immediately, :is_monthly, :is_nsfw, :main_video_embed, :main_video_url, :one_liner, :patron_count, :pay_per_name, :pledge_url, :published_at, :rss_artwork_url, :rss_feed_title, :show_earnings, :summary, :thanks_embed, :thanks_msg, :thanks_video_url, :url, :vanity ] ] )

Specs

get_campaigns(String.t(), [get_campaign_opts()]) :: any()

Returns the campaigns for the user associated with oauth2_token.

Link to this function

get_campaigns_members(oauth2_token, campaign, include_fields \\ [])

Specs

get_campaigns_members(any(), any(), any()) :: [
  Patreon.API.V2.Resource.Member.t()
]
Link to this function

get_identity( oauth2_token, include_fields \\ [ user: [ :about, :can_see_nsfw, :created, :email, :first_name, :full_name, :hide_pledges, :image_url, :is_email_verified, :last_name, :like_count, :social_connections, :thumb_url, :url, :vanity ] ] )

Specs

get_identity(String.t(), [get_identity_opts()]) :: any()

Returns the user associated with oauth2_token. By default, all user fields will be returned unless specified.