CitraClient.Schemas.UserRead (citra_client v0.3.0)

View Source

Struct generated from the UserRead schema.

Fields

  • :creation_epoch — String.t() (API key: creationEpoch)
  • :group — CitraClient.Schemas.UserGroupRead.t()
  • :id — UUID String.t()
  • :isgroupadmin — boolean() — Returns True if the user is the admin of their group.
  • :preferences — CitraClient.Schemas.UserPreferences.t()
  • :tier — UserTier (see OpenAPI spec)
  • :tier_expiration_epoch — String.t() (API key: tierExpirationEpoch)
  • :username — String.t()

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.UserRead{
  creation_epoch: String.t() | nil,
  group: CitraClient.Schemas.UserGroupRead.t() | map() | nil,
  id: String.t() | nil,
  isgroupadmin: boolean() | nil,
  preferences: CitraClient.Schemas.UserPreferences.t() | map() | nil,
  tier: map() | String.t() | nil,
  tier_expiration_epoch: String.t() | nil,
  username: String.t() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.