CitraClient.Schemas.SatelliteTransmissionRead (citra_client v0.3.0)

View Source

Struct generated from the SatelliteTransmissionRead schema.

Fields

  • :antenna_id — UUID String.t() (API key: antennaId)
  • :creation_epoch — String.t() (API key: creationEpoch)
  • :frequency — integer()
  • :id — UUID String.t()
  • :provider — TransmissionProvider (see OpenAPI spec)
  • :reported_epoch — String.t() (API key: reportedEpoch)
  • :satellite_id — UUID String.t() (API key: satelliteId)
  • :user_group_id — UUID String.t() (API key: userGroupId)
  • :user_id — UUID String.t() (API key: userId)
  • :user_tier — UserTier (see OpenAPI spec) (API key: userTier)

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.SatelliteTransmissionRead{
  antenna_id: String.t() | nil,
  creation_epoch: String.t() | nil,
  frequency: integer() | nil,
  id: String.t() | nil,
  provider: map() | String.t() | nil,
  reported_epoch: String.t() | nil,
  satellite_id: String.t() | nil,
  user_group_id: String.t() | nil,
  user_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.