Inttegro.UploadRequests.CreateRequest (inttegro v0.2.0)

Parameters for Create Request in the UploadRequests API.

Build this struct with new!/1 and pass it to the corresponding function on Inttegro.UploadRequests. Required keys are enforced immediately; optional values left as nil are omitted from the request sent to Inttegro.

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()

A validated create request request.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.UploadRequests.CreateRequest{
  attempts: Inttegro.UploadRequests.AttemptsRequest.t() | nil,
  constraints: Inttegro.UploadRequests.ConstraintsInput.t() | nil,
  custom_data: %{optional(String.t()) => String.t()} | nil,
  display: Inttegro.UploadRequests.DisplayInput.t() | nil,
  expires_at: String.t() | nil,
  purpose: String.t(),
  recipient: Inttegro.Files.PartyInput.t() | nil,
  requester: Inttegro.Files.ActorInput.t() | nil,
  resource: Inttegro.Files.ResourceInput.t() | nil,
  subject: Inttegro.Files.PartyInput.t() | nil
}

A validated create request request.

Functions

new!(attrs \\ %{})

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

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