Represents Upload Request 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
Functions
Builds a Inttegro.UploadRequests.UploadRequest and raises KeyError when a required field is missing.
Types
@type t() :: %Inttegro.UploadRequests.UploadRequest{ active: boolean(), attempt: Inttegro.UploadRequests.Attempt.t() | nil, attempts: Inttegro.UploadRequests.Attempts.t(), canceled_at: String.t() | nil, canceled_by: Inttegro.UploadRequests.Actor.t() | nil, constraints: Inttegro.UploadRequests.Constraints.t(), created_at: String.t(), custom_data: %{optional(String.t()) => String.t()} | nil, display: Inttegro.UploadRequests.Display.t(), expired_at: String.t() | nil, expires_at: String.t(), file_id: String.t() | nil, fulfilled_at: String.t() | nil, id: String.t(), latest_error: Inttegro.UploadRequests.LatestError.t() | nil, metadata: %{optional(String.t()) => String.t()} | nil, purpose: String.t(), recipient: Inttegro.Files.Party.t(), requester: Inttegro.UploadRequests.Actor.t(), resource: Inttegro.Files.Resource.t(), status: Inttegro.UploadRequests.Status.t(), subject: Inttegro.Files.Party.t(), updated_at: String.t(), upload_url: String.t() | nil, uploading_at: String.t() | nil }
The decoded upload request value.
Functions
Builds a Inttegro.UploadRequests.UploadRequest and raises KeyError when a required field is missing.