Inttegro.FileLinks.FileLink (inttegro v0.2.0)

Represents File Link data in the FileLinks 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 controlled links for delivering files.

File links can be time-limited, revocable, and protected by a token. Creating and administering links requires a secret key; opening a link uses its public ID and token and intentionally does not send the application's secret key.

Summary

Types

t()

The decoded file link value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.FileLinks.FileLink and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.FileLinks.FileLink{
  access: Inttegro.FileLinks.Access.t(),
  active: boolean(),
  created_at: String.t(),
  created_by: Inttegro.FileLinks.Actor.t(),
  custom_data: %{optional(String.t()) => String.t()} | nil,
  delivery: Inttegro.FileLinks.Delivery.t(),
  expires_at: String.t(),
  file_id: String.t(),
  id: String.t(),
  kind: Inttegro.FileLinks.Kind.t(),
  metadata: %{optional(String.t()) => String.t()} | nil,
  purpose: String.t(),
  revoked_at: String.t() | nil,
  revoked_by: Inttegro.FileLinks.Actor.t() | nil,
  status: Inttegro.FileLinks.Status.t(),
  updated_at: String.t()
}

The decoded file link value.

Functions

new!(attrs \\ %{})

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

Builds a Inttegro.FileLinks.FileLink and raises KeyError when a required field is missing.