CitraClient.Schemas.RFCaptureSummary (citra_client v0.3.0)

View Source

Response schema for RF capture without data field (for list endpoints)

Fields

  • :antenna_id — UUID String.t() (API key: antennaId)
  • :antenna_name — String.t() (API key: antennaName)
  • :capture_end — DateTime.t() (API key: captureEnd)
  • :capture_start — DateTime.t() (API key: captureStart)
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :detection_count — integer() (API key: detectionCount)
  • :id — UUID String.t()
  • :task_id — UUID String.t() (API key: taskId)
  • :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.RFCaptureSummary{
  antenna_id: String.t() | nil,
  antenna_name: String.t() | nil,
  capture_end: DateTime.t() | nil,
  capture_start: DateTime.t() | nil,
  creation_epoch: DateTime.t() | nil,
  detection_count: integer() | nil,
  id: String.t() | nil,
  task_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.