CitraClient.Schemas.UploadStatusResponse (citra_client v0.3.0)

View Source

Struct generated from the UploadStatusResponse schema.

Fields

  • :catalog_download_urlString.t() (API key: catalogDownloadUrl)
  • :checksumString.t()
  • :created_atDateTime.t() (API key: createdAt)
  • :detailString.t()
  • :expires_atDateTime.t() (API key: expiresAt)
  • :fits_download_urlString.t() (API key: fitsDownloadUrl)
  • :fovnumber()
  • :max_sourcesinteger() (API key: maxSources)
  • :original_filenameString.t() (API key: originalFilename)
  • :statusImageStatus (see OpenAPI spec)
  • :task_id — UUID String.t() (API key: taskId)
  • :telescope_id — UUID String.t() (API key: telescopeId)
  • :telescope_nameString.t() (API key: telescopeName)
  • :upload_id — UUID String.t() (API key: uploadId)
  • :user_id — UUID String.t() (API key: userId)
  • :usernameString.t()

Summary

Functions

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

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.UploadStatusResponse{
  catalog_download_url: String.t() | nil,
  checksum: String.t() | nil,
  created_at: DateTime.t() | nil,
  detail: String.t() | nil,
  expires_at: DateTime.t() | nil,
  fits_download_url: String.t() | nil,
  fov: number() | nil,
  max_sources: integer() | nil,
  original_filename: String.t() | nil,
  status: map() | String.t() | nil,
  task_id: String.t() | nil,
  telescope_id: String.t() | nil,
  telescope_name: String.t() | nil,
  upload_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.