CitraClient.Schemas.SatellitePage (citra_client v0.3.0)

View Source

Struct generated from the SatellitePage schema.

Fields

  • :satellites — list of CitraClient.Schemas.SatelliteSummary.t()
  • :total_pages — integer() (API key: totalPages)

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.SatellitePage{
  satellites: [CitraClient.Schemas.SatelliteSummary.t() | map() | nil],
  total_pages: integer() | 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.