Packages
stripity_stripe
2.0.0-alpha.7
3.3.2
3.3.1
3.2.0
3.1.1
3.1.0
3.0.0
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.1
2.15.0
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.3
2.2.2
2.2.1
2.2.0
2.1.0
2.0.1
2.0.0
2.0.0-alpha.11
2.0.0-alpha.10
2.0.0-alpha.9
2.0.0-alpha.8
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.6.2
1.6.1
1.6.0
1.4.0
1.3.0
1.2.0
1.1.0
0.5.0
0.4.0
0.3.0
0.2.0
A Stripe client for Elixir.
Current section
Files
Jump to
Current section
Files
lib/stripe/file_upload.ex
defmodule Stripe.FileUpload do
@moduledoc """
Work with Stripe file_upload objects.
You can:
- Create a file
- Retrieve a file
Stripe API reference: https://stripe.com/docs/api#file_uploads
"""
@type t :: %__MODULE__{}
defstruct [
:id, :object,
:created, :purpose, :size, :type, :metadata
]
@plural_endpoint "files"
@doc """
Create a file according to Stripe's file_upload rules.
Takes the filepath and the purpose.
"""
@spec create(Path.t, String.t, Keyword.t) :: {:ok, t} | {:error, Stripe.api_error_struct}
def create(filepath, purpose, opts \\ []) do
Stripe.Request.create_file_upload(@plural_endpoint, filepath, purpose, opts)
end
@doc """
Retrieve a file_upload.
"""
@spec retrieve(binary, Keyword.t) :: {:ok, t} | {:error, Stripe.api_error_struct}
def retrieve(id, opts \\ []) do
endpoint = @plural_endpoint <> "/" <> id
Stripe.Request.retrieve_file_upload(endpoint, opts)
end
end