exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.FileLinks (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_file_links_link_opts()
get_file_links_opts()

Functions

get_file_links(client, opts \\ [])

description: <p>Returns a list of file links.</p>

get_file_links_link(client, link, opts \\ [])

description: <p>Retrieves the file link with the given ID.</p>

post_file_links(client, body)

description: <p>Creates a new file link object.</p>

post_file_links_link(client, body, link)

description: <p>Updates an existing file link object. Expired links can no longer be updated.</p>

Link to this section Types

Link to this section Functions

Link to this function

get_file_links(client, opts \\ [])

View Source 
@spec get_file_links(client :: ExOAPI.Client.t(), [get_file_links_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.FileLink.t()]
     }
   | map()}
  | {:error, any()}

description: <p>Returns a list of file links.</p>

Link to this function

post_file_links(client, body)

View Source 
@spec post_file_links(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      metadata: String.t() | map(),
      file: String.t(),
      expires_at: integer(),
      expand: [String.t()]
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.FileLink.t() | map()}
  | {:error, any()}

description: <p>Creates a new file link object.</p>

Link to this function

post_file_links_link(client, body, link)

View Source 
@spec post_file_links_link(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      metadata: String.t() | map(),
      expires_at: String.t() | integer() | String.t() | :now,
      expand: [String.t()]
    }
    | map(),
  link :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.FileLink.t() | map()}
  | {:error, any()}

description: <p>Updates an existing file link object. Expired links can no longer be updated.</p>