CitraClient.Schemas.IQUploadInitiateResponse (citra_client v0.3.0)

View Source

Response from initiating an IQ upload - contains presigned URL.

Fields

  • :fields — map()
  • :filename — String.t()
  • :method — String.t()
  • :upload_id — UUID String.t() (API key: uploadId)
  • :upload_url — String.t() (API key: uploadUrl)

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.IQUploadInitiateResponse{
  fields: map() | nil,
  filename: String.t() | nil,
  method: String.t() | nil,
  upload_id: String.t() | nil,
  upload_url: 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.