CitraClient.Schemas.SatelliteGroup (citra_client v0.3.0)

View Source

Complete satellite group schema for responses

Fields

  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :details — String.t() — Detailed description of the satellite group
  • :id — UUID String.t()
  • :is_favorited — boolean() (API key: isFavorited) — Whether the current user has favorited this group
  • :satellite_ids — list of UUID String.t() (API key: satelliteIds) — List of satellite IDs in this group
  • :title — String.t() — Satellite group title
  • :update_epoch — DateTime.t() (API key: updateEpoch)
  • :user_group_id — UUID String.t() (API key: userGroupId) — User group this satellite group belongs to
  • :user_id — UUID String.t() (API key: userId)
  • :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.SatelliteGroup{
  creation_epoch: DateTime.t() | nil,
  details: String.t() | nil,
  id: String.t() | nil,
  is_favorited: boolean() | nil,
  satellite_ids: [String.t() | nil],
  title: String.t() | nil,
  update_epoch: DateTime.t() | nil,
  user_group_id: String.t() | nil,
  user_id: 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.