Inttegro.UploadRequests.Attempt (inttegro v0.2.0)

Represents Attempt data in the UploadRequests API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Creates secure upload requests that let another party supply a file.

The application defines constraints and display information, then gives the uploader the request ID and token. Fulfilment does not use the application's secret key. Review and status operations let the application accept, reject, or cancel the resulting attempt.

Summary

Types

t()

The decoded attempt value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.UploadRequests.Attempt and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.UploadRequests.Attempt{
  attempted_at: String.t(),
  content_type: String.t() | nil,
  declared_size: integer() | nil,
  error: Inttegro.UploadRequests.LatestError.t() | nil,
  failed_at: String.t() | nil,
  file_id: String.t() | nil,
  filename: String.t() | nil,
  id: String.t(),
  ordinal: integer(),
  review: Inttegro.UploadRequests.Review.t() | nil,
  status: String.t(),
  succeeded_at: String.t() | nil,
  upload_request_id: String.t()
}

The decoded attempt value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.UploadRequests.Attempt and raises KeyError when a required field is missing.