Inttegro.FileReferences.Input (inttegro v0.2.0)

Parameters for Input in the FileReferences API.

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

Reconciles references between files and the resources that use them.

References prevent backing objects from being removed while another resource still depends on them. Reconciliation is an administrative operation for repairing or verifying that ownership graph; it is not required for ordinary file downloads.

Summary

Types

t()

A validated input request.

Functions

new!(attrs \\ %{})

Builds a Inttegro.FileReferences.Input and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.FileReferences.Input{
  field: String.t(),
  file_id: String.t(),
  purpose: String.t() | nil,
  reference: String.t() | nil,
  reference_kind: String.t() | nil
}

A validated input request.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.FileReferences.Input and raises KeyError when a required field is missing.