LatticeStripe.FileLink (LatticeStripe v1.7.0)

Copy Markdown View Source

Represents a link to a Stripe file that can be shared outside your account.

FileLinks are top-level resources (not nested under File). They provide publicly accessible URLs with optional expiration. File links expire -- they are not deleted.

{:ok, link} = LatticeStripe.FileLink.create(client, %{
  "file" => "file_abc123"
})

Update Expiration

{:ok, link} = LatticeStripe.FileLink.update(client, "link_abc123", %{
  "expires_at" => 1700000000
})

List with Auto-Pagination

LatticeStripe.FileLink.stream!(client)
|> Enum.take(50)

Stripe API Reference

See the Stripe FileLink API for the full object reference and available parameters.

Summary

Types

t()

Functions

create(client, params \\ %{}, opts \\ [])

Creates a new file link for a given file ID.

create!(client, params \\ %{}, opts \\ [])

Same as create/3 but raises on error.

from_map(map)
list(client, params \\ %{}, opts \\ [])

Lists file links with optional filters.

list!(client, params \\ %{}, opts \\ [])

Same as list/3 but raises on error.

retrieve(client, id, opts \\ [])

Retrieves a file link by ID.

retrieve!(client, id, opts \\ [])

Same as retrieve/3 but raises on error.

stream!(client, params \\ %{}, opts \\ [])

Returns a lazy stream of all file links, auto-paginating as needed.

update(client, id, params, opts \\ [])

Updates a file link (e.g., sets or clears expiration).

update!(client, id, params, opts \\ [])

Same as update/4 but raises on error.

Types

t()

@type t() :: %LatticeStripe.FileLink{
  created: integer() | nil,
  expired: boolean() | nil,
  expires_at: integer() | nil,
  extra: map(),
  file: String.t() | LatticeStripe.File.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  metadata: map(),
  object: String.t(),
  url: String.t() | nil
}

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(LatticeStripe.Client.t(), map(), keyword()) ::
  {:ok, t()} | {:error, LatticeStripe.Error.t()}

Creates a new file link for a given file ID.

create!(client, params \\ %{}, opts \\ [])

@spec create!(LatticeStripe.Client.t(), map(), keyword()) :: t()

Same as create/3 but raises on error.

from_map(map)

@spec from_map(map()) :: t()

list(client, params \\ %{}, opts \\ [])

@spec list(LatticeStripe.Client.t(), map(), keyword()) ::
  {:ok, LatticeStripe.Response.t()} | {:error, LatticeStripe.Error.t()}

Lists file links with optional filters.

list!(client, params \\ %{}, opts \\ [])

@spec list!(LatticeStripe.Client.t(), map(), keyword()) :: LatticeStripe.Response.t()

Same as list/3 but raises on error.

retrieve(client, id, opts \\ [])

@spec retrieve(LatticeStripe.Client.t(), String.t(), keyword()) ::
  {:ok, t()} | {:error, LatticeStripe.Error.t()}

Retrieves a file link by ID.

retrieve!(client, id, opts \\ [])

@spec retrieve!(LatticeStripe.Client.t(), String.t(), keyword()) :: t()

Same as retrieve/3 but raises on error.

stream!(client, params \\ %{}, opts \\ [])

@spec stream!(LatticeStripe.Client.t(), map(), keyword()) :: Enumerable.t()

Returns a lazy stream of all file links, auto-paginating as needed.

update(client, id, params, opts \\ [])

@spec update(LatticeStripe.Client.t(), String.t(), map(), keyword()) ::
  {:ok, t()} | {:error, LatticeStripe.Error.t()}

Updates a file link (e.g., sets or clears expiration).

update!(client, id, params, opts \\ [])

@spec update!(LatticeStripe.Client.t(), String.t(), map(), keyword()) :: t()

Same as update/4 but raises on error.