Inttegro.FileLinks.Access (inttegro v0.3.0)

Represents Access 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 access value.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.FileLinks.Access{
  access_count: integer() | nil,
  allow_download: boolean() | nil,
  allowed_origins: [String.t()] | nil,
  last_accessed_at: DateTime.t() | nil,
  max_accesses: integer() | nil
}

The decoded access value.

Functions

new!(attrs \\ %{})

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

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