CitraClient.Schemas.UserGroupRead (citra_client v0.3.0)

View Source

Struct generated from the UserGroupRead schema.

Fields

  • :admin_user_id — UUID String.t() (API key: adminUserId)
  • :admin_username — String.t() (API key: adminUsername)
  • :creation_epoch — String.t() (API key: creationEpoch)
  • :current_users_count — integer() (API key: currentUsersCount)
  • :id — UUID String.t()
  • :max_seats — integer() (API key: maxSeats)
  • :name — String.t()
  • :tier — UserTier (see OpenAPI spec)
  • :tier_expiration_epoch — String.t() (API key: tierExpirationEpoch)

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.UserGroupRead{
  admin_user_id: String.t() | nil,
  admin_username: String.t() | nil,
  creation_epoch: String.t() | nil,
  current_users_count: integer() | nil,
  id: String.t() | nil,
  max_seats: integer() | nil,
  name: String.t() | nil,
  tier: map() | String.t() | nil,
  tier_expiration_epoch: 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.