CitraClient.Schemas.SatelliteAlias (citra_client v0.3.0)

View Source

Struct generated from the SatelliteAlias schema.

Fields

  • :creation_epochString.t() (API key: creationEpoch)
  • :idString.t()
  • :migration_idString.t() (API key: migrationId)
  • :providerString.t()
  • :provider_alias_epochString.t() (API key: providerAliasEpoch)
  • :provider_satellite_idString.t() (API key: providerSatelliteId)
  • :provider_satellite_nameString.t() (API key: providerSatelliteName)
  • :satellite_idString.t() (API key: satelliteId)
  • :user_group_idString.t() (API key: userGroupId)
  • :user_tierUserTier (see OpenAPI spec) (API key: userTier)

Summary

Functions

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

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.SatelliteAlias{
  creation_epoch: String.t() | nil,
  id: String.t() | nil,
  migration_id: String.t() | nil,
  provider: String.t() | nil,
  provider_alias_epoch: String.t() | nil,
  provider_satellite_id: String.t() | nil,
  provider_satellite_name: String.t() | nil,
  satellite_id: String.t() | nil,
  user_group_id: String.t() | nil,
  user_tier: map() | 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.