View Source Reydenx.User (Reyden-X v0.1.2)

Provides access to methods for obtaining account and balance information

Summary

Functions

User Account

User Balance

Functions

Link to this function

account(token)

View Source (since 0.1.0)
@spec account(
  token :: %Reydenx.Model.Token{
    access_token: term(),
    expires_in: term(),
    token_type: term()
  }
) ::
  {:error,
   %Reydenx.Model.ResponseError{
     message: term(),
     path: term(),
     status_code: term()
   }}
  | {:ok,
     %Reydenx.Model.User{
       currency_id: term(),
       date_joined: term(),
       discount_value: term(),
       email: term(),
       has_image: term(),
       id: term(),
       image_extension: term(),
       image_url: term(),
       is_active: term(),
       is_blocked: term(),
       is_reseller: term(),
       twitch_id: term(),
       twitch_login: term(),
       username: term()
     }}

User Account

API Documentation

Examples:

### Success:

iex> {:ok, token} = Reydenx.new()
iex> Reydenx.User.account(token)
{:ok, %Reydenx.Model.User{}}

### Fail

iex> {:ok, token} = Reydenx.new()
iex> Reydenx.User.account(token)
{:error, %Reydenx.Model.ResponseError{
  path: "/",
  status_code: 404,
  message: "Not Found"
}}
Link to this function

balance(token)

View Source (since 0.1.0)
@spec balance(
  token :: %Reydenx.Model.Token{
    access_token: term(),
    expires_in: term(),
    token_type: term()
  }
) ::
  {:error,
   %Reydenx.Model.ResponseError{
     message: term(),
     path: term(),
     status_code: term()
   }}
  | {:ok,
     %Reydenx.Model.Balance{
       amount: term(),
       currency: term(),
       currency_id: term(),
       formatted_amount: term(),
       id: term(),
       user_id: term()
     }}

User Balance

API Documentation

Examples:

### Success:

iex> {:ok, token} = Reydenx.new()
iex> Reydenx.User.balance(token)
{:ok, %Reydenx.Model.User{}}

### Fail

iex> {:ok, token} = Reydenx.new()
iex> Reydenx.User.balance(token)
{:error, %Reydenx.Model.ResponseError{
  path: "/",
  status_code: 404,
  message: "Not Found"
}}