CitraClient.Schemas.SatelliteGroupUpsert (citra_client v0.3.0)

View Source

Schema for satellite group upsert operations (create or update)

Fields

  • :details — String.t() — Detailed description of the satellite group
  • :id — any() — If provided, updates existing group. If not provided, creates new group.
  • :satellite_ids — list of UUID String.t() (API key: satelliteIds) — List of satellite IDs in this group
  • :title — String.t() — Satellite group title

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.SatelliteGroupUpsert{
  details: String.t() | nil,
  id: any(),
  satellite_ids: [String.t() | nil],
  title: 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.