CitraClient.Schemas.PaginatedResponseSatelliteSummary (citra_client v0.3.0)

View Source

Struct generated from the PaginatedResponse_SatelliteSummary_ schema.

Fields

  • :has_next_page — boolean() (API key: hasNextPage) — Whether there is a next page.
  • :has_previous_page — boolean() (API key: hasPreviousPage) — Whether there is a previous page.
  • :items — list of CitraClient.Schemas.SatelliteSummary.t() — The paginated items
  • :page — integer() — Current page number (zero-based)
  • :page_size — integer() (API key: pageSize) — Number of items per page
  • :total — integer() — Total number of items matching the query
  • :total_pages — integer() (API key: totalPages) — Calculate total number of pages.

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.PaginatedResponseSatelliteSummary{
  has_next_page: boolean() | nil,
  has_previous_page: boolean() | nil,
  items: [CitraClient.Schemas.SatelliteSummary.t() | map() | nil],
  page: integer() | nil,
  page_size: integer() | nil,
  total: integer() | 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.