Inttegro.FileLinks.Page (inttegro v0.2.0)

Copy Markdown View Source

Represents Page 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 page value.

Functions

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

Types

t()

@type t() :: %Inttegro.FileLinks.Page{
  file_links: [Inttegro.FileLinks.FileLink.t()],
  number: integer(),
  size: integer()
}

The decoded page value.

Functions

new!(attrs \\ %{})

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

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