Inttegro.FileLinks.PageRequest (inttegro v0.2.0)

Parameters for Page Request in the FileLinks API.

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

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

A validated page request request.

Functions

new!(attrs \\ %{})

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

Types

t()

@type t() :: %Inttegro.FileLinks.PageRequest{
  file_id: String.t() | nil,
  page_number: integer() | nil,
  page_size: integer() | nil,
  status: Inttegro.FileLinks.Status.t() | nil
}

A validated page request request.

Functions

new!(attrs \\ %{})

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

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